[ binutils/ChangeLog ]
[deliverable/binutils-gdb.git] / binutils / doc / binutils.texi
1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @c Copyright 2001, 2002 Free Software Foundation, Inc.
4
5 @include config.texi
6
7 @ifinfo
8 @format
9 START-INFO-DIR-ENTRY
10 * Binutils: (binutils). The GNU binary utilities.
11 * ar: (binutils)ar. Create, modify, and extract from archives
12 * nm: (binutils)nm. List symbols from object files
13 * objcopy: (binutils)objcopy. Copy and translate object files
14 * objdump: (binutils)objdump. Display information from object files
15 * ranlib: (binutils)ranlib. Generate index to archive contents
16 * readelf: (binutils)readelf. Display the contents of ELF format files.
17 * size: (binutils)size. List section sizes and total size
18 * strings: (binutils)strings. List printable strings from files
19 * strip: (binutils)strip. Discard symbols
20 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols
21 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt
22 * addr2line: (binutils)addr2line. Convert addresses to file and line
23 * nlmconv: (binutils)nlmconv. Converts object code into an NLM
24 * windres: (binutils)windres. Manipulate Windows resources
25 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs
26 END-INFO-DIR-ENTRY
27 @end format
28 @end ifinfo
29
30 @ifinfo
31 @c man begin COPYRIGHT
32 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
33
34 Permission is granted to copy, distribute and/or modify this document
35 under the terms of the GNU Free Documentation License, Version 1.1
36 or any later version published by the Free Software Foundation;
37 with no Invariant Sections, with no Front-Cover Texts, and with no
38 Back-Cover Texts. A copy of the license is included in the
39 section entitled "GNU Free Documentation License".
40
41 @c man end
42 @ignore
43 Permission is granted to process this file through TeX and print the
44 results, provided the printed document carries a copying permission
45 notice identical to this one except for the removal of this paragraph
46 (this paragraph not being relevant to the printed manual).
47
48 @end ignore
49 @end ifinfo
50
51 @synindex ky cp
52 @c
53 @c This file documents the GNU binary utilities "ar", "ld", "objcopy",
54 @c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
55 @c
56 @c Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
57 @c
58 @c This text may be freely distributed under the terms of the GNU
59 @c Free Documentation License.
60 @c
61
62 @setchapternewpage odd
63 @settitle @sc{gnu} Binary Utilities
64 @titlepage
65 @finalout
66 @title The @sc{gnu} Binary Utilities
67 @subtitle Version @value{VERSION}
68 @sp 1
69 @subtitle May 1993
70 @author Roland H. Pesch
71 @author Jeffrey M. Osier
72 @author Cygnus Support
73 @page
74
75 @tex
76 {\parskip=0pt \hfill Cygnus Support\par \hfill
77 \TeX{}info \texinfoversion\par }
78 @end tex
79
80 @vskip 0pt plus 1filll
81 Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998, 2000, 2001, 2002 Free Software Foundation, Inc.
82
83 Permission is granted to copy, distribute and/or modify this document
84 under the terms of the GNU Free Documentation License, Version 1.1
85 or any later version published by the Free Software Foundation;
86 with no Invariant Sections, with no Front-Cover Texts, and with no
87 Back-Cover Texts. A copy of the license is included in the
88 section entitled "GNU Free Documentation License".
89
90 @end titlepage
91
92 @node Top
93 @top Introduction
94
95 @cindex version
96 This brief manual contains preliminary documentation for the @sc{gnu} binary
97 utilities (collectively version @value{VERSION}):
98
99 @iftex
100 @table @code
101 @item ar
102 Create, modify, and extract from archives
103
104 @item nm
105 List symbols from object files
106
107 @item objcopy
108 Copy and translate object files
109
110 @item objdump
111 Display information from object files
112
113 @item ranlib
114 Generate index to archive contents
115
116 @item readelf
117 Display the contents of ELF format files.
118
119 @item size
120 List file section sizes and total size
121
122 @item strings
123 List printable strings from files
124
125 @item strip
126 Discard symbols
127
128 @item c++filt
129 Demangle encoded C++ symbols (on MS-DOS, this program is named
130 @code{cxxfilt})
131
132 @item addr2line
133 Convert addresses into file names and line numbers
134
135 @item nlmconv
136 Convert object code into a Netware Loadable Module
137
138 @item windres
139 Manipulate Windows resources
140
141 @item dlltool
142 Create the files needed to build and use Dynamic Link Libraries
143 @end table
144 @end iftex
145
146 This document is distributed under the terms of the GNU Free
147 Documentation License. A copy of the license is included in the
148 section entitled "GNU Free Documentation License".
149
150 @menu
151 * ar:: Create, modify, and extract from archives
152 * nm:: List symbols from object files
153 * objcopy:: Copy and translate object files
154 * objdump:: Display information from object files
155 * ranlib:: Generate index to archive contents
156 * readelf:: Display the contents of ELF format files.
157 * size:: List section sizes and total size
158 * strings:: List printable strings from files
159 * strip:: Discard symbols
160 * c++filt:: Filter to demangle encoded C++ symbols
161 * cxxfilt: c++filt. MS-DOS name for c++filt
162 * addr2line:: Convert addresses to file and line
163 * nlmconv:: Converts object code into an NLM
164 * windres:: Manipulate Windows resources
165 * dlltool:: Create files needed to build and use DLLs
166 * Selecting The Target System:: How these utilities determine the target.
167 * Reporting Bugs:: Reporting Bugs
168 * GNU Free Documentation License:: GNU Free Documentation License
169 * Index:: Index
170 @end menu
171
172 @node ar
173 @chapter ar
174
175 @kindex ar
176 @cindex archives
177 @cindex collections of files
178
179 @c man title ar create, modify, and extract from archives
180
181 @smallexample
182 ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
183 ar -M [ <mri-script ]
184 @end smallexample
185
186 @c man begin DESCRIPTION ar
187
188 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
189 archives. An @dfn{archive} is a single file holding a collection of
190 other files in a structure that makes it possible to retrieve
191 the original individual files (called @dfn{members} of the archive).
192
193 The original files' contents, mode (permissions), timestamp, owner, and
194 group are preserved in the archive, and can be restored on
195 extraction.
196
197 @cindex name length
198 @sc{gnu} @command{ar} can maintain archives whose members have names of any
199 length; however, depending on how @command{ar} is configured on your
200 system, a limit on member-name length may be imposed for compatibility
201 with archive formats maintained with other tools. If it exists, the
202 limit is often 15 characters (typical of formats related to a.out) or 16
203 characters (typical of formats related to coff).
204
205 @cindex libraries
206 @command{ar} is considered a binary utility because archives of this sort
207 are most often used as @dfn{libraries} holding commonly needed
208 subroutines.
209
210 @cindex symbol index
211 @command{ar} creates an index to the symbols defined in relocatable
212 object modules in the archive when you specify the modifier @samp{s}.
213 Once created, this index is updated in the archive whenever @command{ar}
214 makes a change to its contents (save for the @samp{q} update operation).
215 An archive with such an index speeds up linking to the library, and
216 allows routines in the library to call each other without regard to
217 their placement in the archive.
218
219 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
220 table. If an archive lacks the table, another form of @command{ar} called
221 @command{ranlib} can be used to add just the table.
222
223 @cindex compatibility, @command{ar}
224 @cindex @command{ar} compatibility
225 @sc{gnu} @command{ar} is designed to be compatible with two different
226 facilities. You can control its activity using command-line options,
227 like the different varieties of @command{ar} on Unix systems; or, if you
228 specify the single command-line option @option{-M}, you can control it
229 with a script supplied via standard input, like the MRI ``librarian''
230 program.
231
232 @c man end
233
234 @menu
235 * ar cmdline:: Controlling @command{ar} on the command line
236 * ar scripts:: Controlling @command{ar} with a script
237 @end menu
238
239 @page
240 @node ar cmdline
241 @section Controlling @command{ar} on the command line
242
243 @smallexample
244 @c man begin SYNOPSIS ar
245 ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
246 @c man end
247 @end smallexample
248
249 @cindex Unix compatibility, @command{ar}
250 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
251 arguments to execute: one keyletter specifying the @emph{operation}
252 (optionally accompanied by other keyletters specifying
253 @emph{modifiers}), and the archive name to act on.
254
255 Most operations can also accept further @var{member} arguments,
256 specifying particular files to operate on.
257
258 @c man begin OPTIONS ar
259
260 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
261 flags @var{mod} in any order, within the first command-line argument.
262
263 If you wish, you may begin the first command-line argument with a
264 dash.
265
266 @cindex operations on archive
267 The @var{p} keyletter specifies what operation to execute; it may be
268 any of the following, but you must specify only one of them:
269
270 @table @samp
271 @item d
272 @cindex deleting from archive
273 @emph{Delete} modules from the archive. Specify the names of modules to
274 be deleted as @var{member}@dots{}; the archive is untouched if you
275 specify no files to delete.
276
277 If you specify the @samp{v} modifier, @command{ar} lists each module
278 as it is deleted.
279
280 @item m
281 @cindex moving in archive
282 Use this operation to @emph{move} members in an archive.
283
284 The ordering of members in an archive can make a difference in how
285 programs are linked using the library, if a symbol is defined in more
286 than one member.
287
288 If no modifiers are used with @code{m}, any members you name in the
289 @var{member} arguments are moved to the @emph{end} of the archive;
290 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
291 specified place instead.
292
293 @item p
294 @cindex printing from archive
295 @emph{Print} the specified members of the archive, to the standard
296 output file. If the @samp{v} modifier is specified, show the member
297 name before copying its contents to standard output.
298
299 If you specify no @var{member} arguments, all the files in the archive are
300 printed.
301
302 @item q
303 @cindex quick append to archive
304 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
305 @var{archive}, without checking for replacement.
306
307 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
308 operation; new members are always placed at the end of the archive.
309
310 The modifier @samp{v} makes @command{ar} list each file as it is appended.
311
312 Since the point of this operation is speed, the archive's symbol table
313 index is not updated, even if it already existed; you can use @samp{ar s} or
314 @command{ranlib} explicitly to update the symbol table index.
315
316 However, too many different systems assume quick append rebuilds the
317 index, so GNU ar implements @code{q} as a synonym for @code{r}.
318
319 @item r
320 @cindex replacement in archive
321 Insert the files @var{member}@dots{} into @var{archive} (with
322 @emph{replacement}). This operation differs from @samp{q} in that any
323 previously existing members are deleted if their names match those being
324 added.
325
326 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
327 displays an error message, and leaves undisturbed any existing members
328 of the archive matching that name.
329
330 By default, new members are added at the end of the file; but you may
331 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
332 placement relative to some existing member.
333
334 The modifier @samp{v} used with this operation elicits a line of
335 output for each file inserted, along with one of the letters @samp{a} or
336 @samp{r} to indicate whether the file was appended (no old member
337 deleted) or replaced.
338
339 @item t
340 @cindex contents of archive
341 Display a @emph{table} listing the contents of @var{archive}, or those
342 of the files listed in @var{member}@dots{} that are present in the
343 archive. Normally only the member name is shown; if you also want to
344 see the modes (permissions), timestamp, owner, group, and size, you can
345 request that by also specifying the @samp{v} modifier.
346
347 If you do not specify a @var{member}, all files in the archive
348 are listed.
349
350 @cindex repeated names in archive
351 @cindex name duplication in archive
352 If there is more than one file with the same name (say, @samp{fie}) in
353 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
354 first instance; to see them all, you must ask for a complete
355 listing---in our example, @samp{ar t b.a}.
356 @c WRS only; per Gumby, this is implementation-dependent, and in a more
357 @c recent case in fact works the other way.
358
359 @item x
360 @cindex extract from archive
361 @emph{Extract} members (named @var{member}) from the archive. You can
362 use the @samp{v} modifier with this operation, to request that
363 @command{ar} list each name as it extracts it.
364
365 If you do not specify a @var{member}, all files in the archive
366 are extracted.
367
368 @end table
369
370 A number of modifiers (@var{mod}) may immediately follow the @var{p}
371 keyletter, to specify variations on an operation's behavior:
372
373 @table @samp
374 @item a
375 @cindex relative placement in archive
376 Add new files @emph{after} an existing member of the
377 archive. If you use the modifier @samp{a}, the name of an existing archive
378 member must be present as the @var{relpos} argument, before the
379 @var{archive} specification.
380
381 @item b
382 Add new files @emph{before} an existing member of the
383 archive. If you use the modifier @samp{b}, the name of an existing archive
384 member must be present as the @var{relpos} argument, before the
385 @var{archive} specification. (same as @samp{i}).
386
387 @item c
388 @cindex creating archives
389 @emph{Create} the archive. The specified @var{archive} is always
390 created if it did not exist, when you request an update. But a warning is
391 issued unless you specify in advance that you expect to create it, by
392 using this modifier.
393
394 @item f
395 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
396 names of any length. This will cause it to create archives which are
397 not compatible with the native @command{ar} program on some systems. If
398 this is a concern, the @samp{f} modifier may be used to truncate file
399 names when putting them in the archive.
400
401 @item i
402 Insert new files @emph{before} an existing member of the
403 archive. If you use the modifier @samp{i}, the name of an existing archive
404 member must be present as the @var{relpos} argument, before the
405 @var{archive} specification. (same as @samp{b}).
406
407 @item l
408 This modifier is accepted but not used.
409 @c whaffor ar l modifier??? presumably compat; with
410 @c what???---doc@@cygnus.com, 25jan91
411
412 @item N
413 Uses the @var{count} parameter. This is used if there are multiple
414 entries in the archive with the same name. Extract or delete instance
415 @var{count} of the given name from the archive.
416
417 @item o
418 @cindex dates in archive
419 Preserve the @emph{original} dates of members when extracting them. If
420 you do not specify this modifier, files extracted from the archive
421 are stamped with the time of extraction.
422
423 @item P
424 Use the full path name when matching names in the archive. @sc{gnu}
425 @command{ar} can not create an archive with a full path name (such archives
426 are not POSIX complaint), but other archive creators can. This option
427 will cause @sc{gnu} @command{ar} to match file names using a complete path
428 name, which can be convenient when extracting a single file from an
429 archive created by another tool.
430
431 @item s
432 @cindex writing archive index
433 Write an object-file index into the archive, or update an existing one,
434 even if no other change is made to the archive. You may use this modifier
435 flag either with any operation, or alone. Running @samp{ar s} on an
436 archive is equivalent to running @samp{ranlib} on it.
437
438 @item S
439 @cindex not writing archive index
440 Do not generate an archive symbol table. This can speed up building a
441 large library in several steps. The resulting archive can not be used
442 with the linker. In order to build a symbol table, you must omit the
443 @samp{S} modifier on the last execution of @samp{ar}, or you must run
444 @samp{ranlib} on the archive.
445
446 @item u
447 @cindex updating an archive
448 Normally, @samp{ar r}@dots{} inserts all files
449 listed into the archive. If you would like to insert @emph{only} those
450 of the files you list that are newer than existing members of the same
451 names, use this modifier. The @samp{u} modifier is allowed only for the
452 operation @samp{r} (replace). In particular, the combination @samp{qu} is
453 not allowed, since checking the timestamps would lose any speed
454 advantage from the operation @samp{q}.
455
456 @item v
457 This modifier requests the @emph{verbose} version of an operation. Many
458 operations display additional information, such as filenames processed,
459 when the modifier @samp{v} is appended.
460
461 @item V
462 This modifier shows the version number of @command{ar}.
463 @end table
464
465 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
466 compatibility with AIX. The behaviour produced by this option is the
467 default for GNU @command{ar}. @command{ar} does not support any of the other
468 @samp{-X} options; in particular, it does not support @option{-X32}
469 which is the default for AIX @command{ar}.
470
471 @c man end
472
473 @ignore
474 @c man begin SEEALSO ar
475 nm(1), ranlib(1), and the Info entries for @file{binutils}.
476 @c man end
477 @end ignore
478
479 @node ar scripts
480 @section Controlling @command{ar} with a script
481
482 @smallexample
483 ar -M [ <@var{script} ]
484 @end smallexample
485
486 @cindex MRI compatibility, @command{ar}
487 @cindex scripts, @command{ar}
488 If you use the single command-line option @samp{-M} with @command{ar}, you
489 can control its operation with a rudimentary command language. This
490 form of @command{ar} operates interactively if standard input is coming
491 directly from a terminal. During interactive use, @command{ar} prompts for
492 input (the prompt is @samp{AR >}), and continues executing even after
493 errors. If you redirect standard input to a script file, no prompts are
494 issued, and @command{ar} abandons execution (with a nonzero exit code)
495 on any error.
496
497 The @command{ar} command language is @emph{not} designed to be equivalent
498 to the command-line options; in fact, it provides somewhat less control
499 over archives. The only purpose of the command language is to ease the
500 transition to @sc{gnu} @command{ar} for developers who already have scripts
501 written for the MRI ``librarian'' program.
502
503 The syntax for the @command{ar} command language is straightforward:
504 @itemize @bullet
505 @item
506 commands are recognized in upper or lower case; for example, @code{LIST}
507 is the same as @code{list}. In the following descriptions, commands are
508 shown in upper case for clarity.
509
510 @item
511 a single command may appear on each line; it is the first word on the
512 line.
513
514 @item
515 empty lines are allowed, and have no effect.
516
517 @item
518 comments are allowed; text after either of the characters @samp{*}
519 or @samp{;} is ignored.
520
521 @item
522 Whenever you use a list of names as part of the argument to an @command{ar}
523 command, you can separate the individual names with either commas or
524 blanks. Commas are shown in the explanations below, for clarity.
525
526 @item
527 @samp{+} is used as a line continuation character; if @samp{+} appears
528 at the end of a line, the text on the following line is considered part
529 of the current command.
530 @end itemize
531
532 Here are the commands you can use in @command{ar} scripts, or when using
533 @command{ar} interactively. Three of them have special significance:
534
535 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
536 a temporary file required for most of the other commands.
537
538 @code{SAVE} commits the changes so far specified by the script. Prior
539 to @code{SAVE}, commands affect only the temporary copy of the current
540 archive.
541
542 @table @code
543 @item ADDLIB @var{archive}
544 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
545 Add all the contents of @var{archive} (or, if specified, each named
546 @var{module} from @var{archive}) to the current archive.
547
548 Requires prior use of @code{OPEN} or @code{CREATE}.
549
550 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
551 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
552 @c else like "ar q..."
553 Add each named @var{member} as a module in the current archive.
554
555 Requires prior use of @code{OPEN} or @code{CREATE}.
556
557 @item CLEAR
558 Discard the contents of the current archive, canceling the effect of
559 any operations since the last @code{SAVE}. May be executed (with no
560 effect) even if no current archive is specified.
561
562 @item CREATE @var{archive}
563 Creates an archive, and makes it the current archive (required for many
564 other commands). The new archive is created with a temporary name; it
565 is not actually saved as @var{archive} until you use @code{SAVE}.
566 You can overwrite existing archives; similarly, the contents of any
567 existing file named @var{archive} will not be destroyed until @code{SAVE}.
568
569 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
570 Delete each listed @var{module} from the current archive; equivalent to
571 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
572
573 Requires prior use of @code{OPEN} or @code{CREATE}.
574
575 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
576 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
577 List each named @var{module} present in @var{archive}. The separate
578 command @code{VERBOSE} specifies the form of the output: when verbose
579 output is off, output is like that of @samp{ar -t @var{archive}
580 @var{module}@dots{}}. When verbose output is on, the listing is like
581 @samp{ar -tv @var{archive} @var{module}@dots{}}.
582
583 Output normally goes to the standard output stream; however, if you
584 specify @var{outputfile} as a final argument, @command{ar} directs the
585 output to that file.
586
587 @item END
588 Exit from @command{ar}, with a @code{0} exit code to indicate successful
589 completion. This command does not save the output file; if you have
590 changed the current archive since the last @code{SAVE} command, those
591 changes are lost.
592
593 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
594 Extract each named @var{module} from the current archive, writing them
595 into the current directory as separate files. Equivalent to @samp{ar -x
596 @var{archive} @var{module}@dots{}}.
597
598 Requires prior use of @code{OPEN} or @code{CREATE}.
599
600 @ignore
601 @c FIXME Tokens but no commands???
602 @item FULLDIR
603
604 @item HELP
605 @end ignore
606
607 @item LIST
608 Display full contents of the current archive, in ``verbose'' style
609 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
610 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
611 enhancement, rather than present for MRI compatibility.)
612
613 Requires prior use of @code{OPEN} or @code{CREATE}.
614
615 @item OPEN @var{archive}
616 Opens an existing archive for use as the current archive (required for
617 many other commands). Any changes as the result of subsequent commands
618 will not actually affect @var{archive} until you next use @code{SAVE}.
619
620 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
621 In the current archive, replace each existing @var{module} (named in
622 the @code{REPLACE} arguments) from files in the current working directory.
623 To execute this command without errors, both the file, and the module in
624 the current archive, must exist.
625
626 Requires prior use of @code{OPEN} or @code{CREATE}.
627
628 @item VERBOSE
629 Toggle an internal flag governing the output from @code{DIRECTORY}.
630 When the flag is on, @code{DIRECTORY} output matches output from
631 @samp{ar -tv }@dots{}.
632
633 @item SAVE
634 Commit your changes to the current archive, and actually save it as a
635 file with the name specified in the last @code{CREATE} or @code{OPEN}
636 command.
637
638 Requires prior use of @code{OPEN} or @code{CREATE}.
639
640 @end table
641
642 @iftex
643 @node ld
644 @chapter ld
645 @cindex linker
646 @kindex ld
647 The @sc{gnu} linker @command{ld} is now described in a separate manual.
648 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
649 @end iftex
650
651 @node nm
652 @chapter nm
653 @cindex symbols
654 @kindex nm
655
656 @c man title nm list symbols from object files
657
658 @smallexample
659 @c man begin SYNOPSIS nm
660 nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
661 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
662 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
663 [@option{-A}|@option{-o}|@option{--print-file-name}]
664 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
665 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
666 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
667 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
668 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
669 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
670 @c man end
671 @end smallexample
672
673 @c man begin DESCRIPTION nm
674 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
675 If no object files are listed as arguments, @command{nm} assumes the file
676 @file{a.out}.
677
678 For each symbol, @command{nm} shows:
679
680 @itemize @bullet
681 @item
682 The symbol value, in the radix selected by options (see below), or
683 hexadecimal by default.
684
685 @item
686 The symbol type. At least the following types are used; others are, as
687 well, depending on the object file format. If lowercase, the symbol is
688 local; if uppercase, the symbol is global (external).
689
690 @c Some more detail on exactly what these symbol types are used for
691 @c would be nice.
692 @table @code
693 @item A
694 The symbol's value is absolute, and will not be changed by further
695 linking.
696
697 @item B
698 The symbol is in the uninitialized data section (known as BSS).
699
700 @item C
701 The symbol is common. Common symbols are uninitialized data. When
702 linking, multiple common symbols may appear with the same name. If the
703 symbol is defined anywhere, the common symbols are treated as undefined
704 references.
705 @ifclear man
706 For more details on common symbols, see the discussion of
707 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
708 @end ifclear
709
710 @item D
711 The symbol is in the initialized data section.
712
713 @item G
714 The symbol is in an initialized data section for small objects. Some
715 object file formats permit more efficient access to small data objects,
716 such as a global int variable as opposed to a large global array.
717
718 @item I
719 The symbol is an indirect reference to another symbol. This is a GNU
720 extension to the a.out object file format which is rarely used.
721
722 @item N
723 The symbol is a debugging symbol.
724
725 @item R
726 The symbol is in a read only data section.
727
728 @item S
729 The symbol is in an uninitialized data section for small objects.
730
731 @item T
732 The symbol is in the text (code) section.
733
734 @item U
735 The symbol is undefined.
736
737 @item V
738 The symbol is a weak object. When a weak defined symbol is linked with
739 a normal defined symbol, the normal defined symbol is used with no error.
740 When a weak undefined symbol is linked and the symbol is not defined,
741 the value of the weak symbol becomes zero with no error.
742
743 @item W
744 The symbol is a weak symbol that has not been specifically tagged as a
745 weak object symbol. When a weak defined symbol is linked with a normal
746 defined symbol, the normal defined symbol is used with no error.
747 When a weak undefined symbol is linked and the symbol is not defined,
748 the value of the weak symbol becomes zero with no error.
749
750 @item -
751 The symbol is a stabs symbol in an a.out object file. In this case, the
752 next values printed are the stabs other field, the stabs desc field, and
753 the stab type. Stabs symbols are used to hold debugging information.
754 @ifclear man
755 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
756 ``stabs'' debug format}.
757 @end ifclear
758
759 @item ?
760 The symbol type is unknown, or object file format specific.
761 @end table
762
763 @item
764 The symbol name.
765 @end itemize
766
767 @c man end
768
769 @c man begin OPTIONS nm
770 The long and short forms of options, shown here as alternatives, are
771 equivalent.
772
773 @table @env
774 @item -A
775 @itemx -o
776 @itemx --print-file-name
777 @cindex input file name
778 @cindex file name
779 @cindex source file name
780 Precede each symbol by the name of the input file (or archive member)
781 in which it was found, rather than identifying the input file once only,
782 before all of its symbols.
783
784 @item -a
785 @itemx --debug-syms
786 @cindex debugging symbols
787 Display all symbols, even debugger-only symbols; normally these are not
788 listed.
789
790 @item -B
791 @cindex @command{nm} format
792 @cindex @command{nm} compatibility
793 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
794
795 @item -C
796 @itemx --demangle[=@var{style}]
797 @cindex demangling in nm
798 Decode (@dfn{demangle}) low-level symbol names into user-level names.
799 Besides removing any initial underscore prepended by the system, this
800 makes C++ function names readable. Different compilers have different
801 mangling styles. The optional demangling style argument can be used to
802 choose an appropriate demangling style for your compiler. @xref{c++filt},
803 for more information on demangling.
804
805 @item --no-demangle
806 Do not demangle low-level symbol names. This is the default.
807
808 @item -D
809 @itemx --dynamic
810 @cindex dynamic symbols
811 Display the dynamic symbols rather than the normal symbols. This is
812 only meaningful for dynamic objects, such as certain types of shared
813 libraries.
814
815 @item -f @var{format}
816 @itemx --format=@var{format}
817 @cindex @command{nm} format
818 @cindex @command{nm} compatibility
819 Use the output format @var{format}, which can be @code{bsd},
820 @code{sysv}, or @code{posix}. The default is @code{bsd}.
821 Only the first character of @var{format} is significant; it can be
822 either upper or lower case.
823
824 @item -g
825 @itemx --extern-only
826 @cindex external symbols
827 Display only external symbols.
828
829 @item -l
830 @itemx --line-numbers
831 @cindex symbol line numbers
832 For each symbol, use debugging information to try to find a filename and
833 line number. For a defined symbol, look for the line number of the
834 address of the symbol. For an undefined symbol, look for the line
835 number of a relocation entry which refers to the symbol. If line number
836 information can be found, print it after the other symbol information.
837
838 @item -n
839 @itemx -v
840 @itemx --numeric-sort
841 Sort symbols numerically by their addresses, rather than alphabetically
842 by their names.
843
844 @item -p
845 @itemx --no-sort
846 @cindex sorting symbols
847 Do not bother to sort the symbols in any order; print them in the order
848 encountered.
849
850 @item -P
851 @itemx --portability
852 Use the POSIX.2 standard output format instead of the default format.
853 Equivalent to @samp{-f posix}.
854
855 @item -S
856 @itemx --print-size
857 Print size of defined symbols for the @code{bsd} output format.
858
859 @item -s
860 @itemx --print-armap
861 @cindex symbol index, listing
862 When listing symbols from archive members, include the index: a mapping
863 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
864 contain definitions for which names.
865
866 @item -r
867 @itemx --reverse-sort
868 Reverse the order of the sort (whether numeric or alphabetic); let the
869 last come first.
870
871 @item --size-sort
872 Sort symbols by size. The size is computed as the difference between
873 the value of the symbol and the value of the symbol with the next higher
874 value. The size of the symbol is printed, rather than the value.
875
876 @item -t @var{radix}
877 @itemx --radix=@var{radix}
878 Use @var{radix} as the radix for printing the symbol values. It must be
879 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
880
881 @item --target=@var{bfdname}
882 @cindex object code format
883 Specify an object code format other than your system's default format.
884 @xref{Target Selection}, for more information.
885
886 @item -u
887 @itemx --undefined-only
888 @cindex external symbols
889 @cindex undefined symbols
890 Display only undefined symbols (those external to each object file).
891
892 @item --defined-only
893 @cindex external symbols
894 @cindex undefined symbols
895 Display only defined symbols for each object file.
896
897 @item -V
898 @itemx --version
899 Show the version number of @command{nm} and exit.
900
901 @item -X
902 This option is ignored for compatibility with the AIX version of
903 @command{nm}. It takes one parameter which must be the string
904 @option{32_64}. The default mode of AIX @command{nm} corresponds
905 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
906
907 @item --help
908 Show a summary of the options to @command{nm} and exit.
909 @end table
910
911 @c man end
912
913 @ignore
914 @c man begin SEEALSO nm
915 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
916 @c man end
917 @end ignore
918
919 @node objcopy
920 @chapter objcopy
921
922 @c man title objcopy copy and translate object files
923
924 @smallexample
925 @c man begin SYNOPSIS objcopy
926 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
927 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
928 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
929 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
930 [@option{-S}|@option{--strip-all}] [@option{-g}|@option{--strip-debug}]
931 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
932 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
933 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
934 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
935 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
936 [@option{-x}|@option{--discard-all}] [@option{-X}|@option{--discard-locals}]
937 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
938 [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
939 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
940 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
941 [@option{-p}|@option{--preserve-dates}]
942 [@option{--debugging}]
943 [@option{--gap-fill=}@var{val}] [@option{--pad-to=}@var{address}]
944 [@option{--set-start=}@var{val}] [@option{--adjust-start=}@var{incr}]
945 [@option{--change-addresses=}@var{incr}]
946 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
947 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
948 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
949 [@option{--change-warnings}] [@option{--no-change-warnings}]
950 [@option{--set-section-flags} @var{section}=@var{flags}]
951 [@option{--add-section} @var{sectionname}=@var{filename}]
952 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
953 [@option{--change-leading-char} ] [@option{--remove-leading-char}]
954 [@option{--srec-len=}@var{ival} ] [@option{--srec-forceS3}]
955 [@option{--redefine-sym} @var{old}=@var{new} ]
956 [@option{--weaken}]
957 [@option{--keep-symbols=}@var{filename}]
958 [@option{--strip-symbols=}@var{filename}]
959 [@option{--keep-global-symbols=}@var{filename}]
960 [@option{--localize-symbols=}@var{filename}]
961 [@option{--weaken-symbols=}@var{filename}]
962 [@option{--alt-machine-code=}@var{index}]
963 [@option{--prefix-symbols=}@var{string}]
964 [@option{--prefix-sections=}@var{string}]
965 [@option{--prefix-alloc-sections=}@var{string}]
966 [@option{-v}|@option{--verbose}]
967 [@option{-V}|@option{--version}]
968 [@option{--help}]
969 @var{infile} [@var{outfile}]
970 @c man end
971 @end smallexample
972
973 @c man begin DESCRIPTION objcopy
974 The @sc{gnu} @command{objcopy} utility copies the contents of an object
975 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
976 read and write the object files. It can write the destination object
977 file in a format different from that of the source object file. The
978 exact behavior of @command{objcopy} is controlled by command-line options.
979 Note that @command{objcopy} should be able to copy a fully linked file
980 between any two formats. However, copying a relocatable object file
981 between any two formats may not work as expected.
982
983 @command{objcopy} creates temporary files to do its translations and
984 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
985 translation work; it has access to all the formats described in @sc{bfd}
986 and thus is able to recognize most formats without being told
987 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
988
989 @command{objcopy} can be used to generate S-records by using an output
990 target of @samp{srec} (e.g., use @samp{-O srec}).
991
992 @command{objcopy} can be used to generate a raw binary file by using an
993 output target of @samp{binary} (e.g., use @option{-O binary}). When
994 @command{objcopy} generates a raw binary file, it will essentially produce
995 a memory dump of the contents of the input object file. All symbols and
996 relocation information will be discarded. The memory dump will start at
997 the load address of the lowest section copied into the output file.
998
999 When generating an S-record or a raw binary file, it may be helpful to
1000 use @option{-S} to remove sections containing debugging information. In
1001 some cases @option{-R} will be useful to remove sections which contain
1002 information that is not needed by the binary file.
1003
1004 Note - @command{objcopy} is not able to change the endianness of its input
1005 files. If the input format has an endianness, (some formats do not),
1006 @command{objcopy} can only copy the inputs into file formats that have the
1007 same endianness or which have no endianness (eg @samp{srec}).
1008
1009 @c man end
1010
1011 @c man begin OPTIONS objcopy
1012
1013 @table @env
1014 @item @var{infile}
1015 @itemx @var{outfile}
1016 The input and output files, respectively.
1017 If you do not specify @var{outfile}, @command{objcopy} creates a
1018 temporary file and destructively renames the result with
1019 the name of @var{infile}.
1020
1021 @item -I @var{bfdname}
1022 @itemx --input-target=@var{bfdname}
1023 Consider the source file's object format to be @var{bfdname}, rather than
1024 attempting to deduce it. @xref{Target Selection}, for more information.
1025
1026 @item -O @var{bfdname}
1027 @itemx --output-target=@var{bfdname}
1028 Write the output file using the object format @var{bfdname}.
1029 @xref{Target Selection}, for more information.
1030
1031 @item -F @var{bfdname}
1032 @itemx --target=@var{bfdname}
1033 Use @var{bfdname} as the object format for both the input and the output
1034 file; i.e., simply transfer data from source to destination with no
1035 translation. @xref{Target Selection}, for more information.
1036
1037 @item -B @var{bfdarch}
1038 @itemx --binary-architecture=@var{bfdarch}
1039 Useful when transforming a raw binary input file into an object file.
1040 In this case the output architecture can be set to @var{bfdarch}. This
1041 option will be ignored if the input file has a known @var{bfdarch}. You
1042 can access this binary data inside a program by referencing the special
1043 symbols that are created by the conversion process. These symbols are
1044 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1045 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1046 an object file and then access it in your code using these symbols.
1047
1048 @item -j @var{sectionname}
1049 @itemx --only-section=@var{sectionname}
1050 Copy only the named section from the input file to the output file.
1051 This option may be given more than once. Note that using this option
1052 inappropriately may make the output file unusable.
1053
1054 @item -R @var{sectionname}
1055 @itemx --remove-section=@var{sectionname}
1056 Remove any section named @var{sectionname} from the output file. This
1057 option may be given more than once. Note that using this option
1058 inappropriately may make the output file unusable.
1059
1060 @item -S
1061 @itemx --strip-all
1062 Do not copy relocation and symbol information from the source file.
1063
1064 @item -g
1065 @itemx --strip-debug
1066 Do not copy debugging symbols from the source file.
1067
1068 @item --strip-unneeded
1069 Strip all symbols that are not needed for relocation processing.
1070
1071 @item -K @var{symbolname}
1072 @itemx --keep-symbol=@var{symbolname}
1073 Copy only symbol @var{symbolname} from the source file. This option may
1074 be given more than once.
1075
1076 @item -N @var{symbolname}
1077 @itemx --strip-symbol=@var{symbolname}
1078 Do not copy symbol @var{symbolname} from the source file. This option
1079 may be given more than once.
1080
1081 @item -G @var{symbolname}
1082 @itemx --keep-global-symbol=@var{symbolname}
1083 Keep only symbol @var{symbolname} global. Make all other symbols local
1084 to the file, so that they are not visible externally. This option may
1085 be given more than once.
1086
1087 @item -L @var{symbolname}
1088 @itemx --localize-symbol=@var{symbolname}
1089 Make symbol @var{symbolname} local to the file, so that it is not
1090 visible externally. This option may be given more than once.
1091
1092 @item -W @var{symbolname}
1093 @itemx --weaken-symbol=@var{symbolname}
1094 Make symbol @var{symbolname} weak. This option may be given more than once.
1095
1096 @item -x
1097 @itemx --discard-all
1098 Do not copy non-global symbols from the source file.
1099 @c FIXME any reason to prefer "non-global" to "local" here?
1100
1101 @item -X
1102 @itemx --discard-locals
1103 Do not copy compiler-generated local symbols.
1104 (These usually start with @samp{L} or @samp{.}.)
1105
1106 @item -b @var{byte}
1107 @itemx --byte=@var{byte}
1108 Keep only every @var{byte}th byte of the input file (header data is not
1109 affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
1110 where @var{interleave} is given by the @option{-i} or @option{--interleave}
1111 option, or the default of 4. This option is useful for creating files
1112 to program @sc{rom}. It is typically used with an @code{srec} output
1113 target.
1114
1115 @item -i @var{interleave}
1116 @itemx --interleave=@var{interleave}
1117 Only copy one out of every @var{interleave} bytes. Select which byte to
1118 copy with the @option{-b} or @option{--byte} option. The default is 4.
1119 @command{objcopy} ignores this option if you do not specify either @option{-b} or
1120 @option{--byte}.
1121
1122 @item -p
1123 @itemx --preserve-dates
1124 Set the access and modification dates of the output file to be the same
1125 as those of the input file.
1126
1127 @item --debugging
1128 Convert debugging information, if possible. This is not the default
1129 because only certain debugging formats are supported, and the
1130 conversion process can be time consuming.
1131
1132 @item --gap-fill @var{val}
1133 Fill gaps between sections with @var{val}. This operation applies to
1134 the @emph{load address} (LMA) of the sections. It is done by increasing
1135 the size of the section with the lower address, and filling in the extra
1136 space created with @var{val}.
1137
1138 @item --pad-to @var{address}
1139 Pad the output file up to the load address @var{address}. This is
1140 done by increasing the size of the last section. The extra space is
1141 filled in with the value specified by @option{--gap-fill} (default zero).
1142
1143 @item --set-start @var{val}
1144 Set the start address of the new file to @var{val}. Not all object file
1145 formats support setting the start address.
1146
1147 @item --change-start @var{incr}
1148 @itemx --adjust-start @var{incr}
1149 @cindex changing start address
1150 Change the start address by adding @var{incr}. Not all object file
1151 formats support setting the start address.
1152
1153 @item --change-addresses @var{incr}
1154 @itemx --adjust-vma @var{incr}
1155 @cindex changing object addresses
1156 Change the VMA and LMA addresses of all sections, as well as the start
1157 address, by adding @var{incr}. Some object file formats do not permit
1158 section addresses to be changed arbitrarily. Note that this does not
1159 relocate the sections; if the program expects sections to be loaded at a
1160 certain address, and this option is used to change the sections such
1161 that they are loaded at a different address, the program may fail.
1162
1163 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1164 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1165 @cindex changing section address
1166 Set or change both the VMA address and the LMA address of the named
1167 @var{section}. If @samp{=} is used, the section address is set to
1168 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1169 section address. See the comments under @option{--change-addresses},
1170 above. If @var{section} does not exist in the input file, a warning will
1171 be issued, unless @option{--no-change-warnings} is used.
1172
1173 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1174 @cindex changing section LMA
1175 Set or change the LMA address of the named @var{section}. The LMA
1176 address is the address where the section will be loaded into memory at
1177 program load time. Normally this is the same as the VMA address, which
1178 is the address of the section at program run time, but on some systems,
1179 especially those where a program is held in ROM, the two can be
1180 different. If @samp{=} is used, the section address is set to
1181 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1182 section address. See the comments under @option{--change-addresses},
1183 above. If @var{section} does not exist in the input file, a warning
1184 will be issued, unless @option{--no-change-warnings} is used.
1185
1186 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1187 @cindex changing section VMA
1188 Set or change the VMA address of the named @var{section}. The VMA
1189 address is the address where the section will be located once the
1190 program has started executing. Normally this is the same as the LMA
1191 address, which is the address where the section will be loaded into
1192 memory, but on some systems, especially those where a program is held in
1193 ROM, the two can be different. If @samp{=} is used, the section address
1194 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1195 from the section address. See the comments under
1196 @option{--change-addresses}, above. If @var{section} does not exist in
1197 the input file, a warning will be issued, unless
1198 @option{--no-change-warnings} is used.
1199
1200 @item --change-warnings
1201 @itemx --adjust-warnings
1202 If @option{--change-section-address} or @option{--change-section-lma} or
1203 @option{--change-section-vma} is used, and the named section does not
1204 exist, issue a warning. This is the default.
1205
1206 @item --no-change-warnings
1207 @itemx --no-adjust-warnings
1208 Do not issue a warning if @option{--change-section-address} or
1209 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1210 if the named section does not exist.
1211
1212 @item --set-section-flags @var{section}=@var{flags}
1213 Set the flags for the named section. The @var{flags} argument is a
1214 comma separated string of flag names. The recognized names are
1215 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1216 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1217 @samp{debug}. You can set the @samp{contents} flag for a section which
1218 does not have contents, but it is not meaningful to clear the
1219 @samp{contents} flag of a section which does have contents--just remove
1220 the section instead. Not all flags are meaningful for all object file
1221 formats.
1222
1223 @item --add-section @var{sectionname}=@var{filename}
1224 Add a new section named @var{sectionname} while copying the file. The
1225 contents of the new section are taken from the file @var{filename}. The
1226 size of the section will be the size of the file. This option only
1227 works on file formats which can support sections with arbitrary names.
1228
1229 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1230 Rename a section from @var{oldname} to @var{newname}, optionally
1231 changing the section's flags to @var{flags} in the process. This has
1232 the advantage over usng a linker script to perform the rename in that
1233 the output stays as an object file and does not become a linked
1234 executable.
1235
1236 This option is particularly helpful when the input format is binary,
1237 since this will always create a section called .data. If for example,
1238 you wanted instead to create a section called .rodata containing binary
1239 data you could use the following command line to achieve it:
1240
1241 @smallexample
1242 objcopy -I binary -O <output_format> -B <architecture> \
1243 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1244 <input_binary_file> <output_object_file>
1245 @end smallexample
1246
1247 @item --change-leading-char
1248 Some object file formats use special characters at the start of
1249 symbols. The most common such character is underscore, which compilers
1250 often add before every symbol. This option tells @command{objcopy} to
1251 change the leading character of every symbol when it converts between
1252 object file formats. If the object file formats use the same leading
1253 character, this option has no effect. Otherwise, it will add a
1254 character, or remove a character, or change a character, as
1255 appropriate.
1256
1257 @item --remove-leading-char
1258 If the first character of a global symbol is a special symbol leading
1259 character used by the object file format, remove the character. The
1260 most common symbol leading character is underscore. This option will
1261 remove a leading underscore from all global symbols. This can be useful
1262 if you want to link together objects of different file formats with
1263 different conventions for symbol names. This is different from
1264 @option{--change-leading-char} because it always changes the symbol name
1265 when appropriate, regardless of the object file format of the output
1266 file.
1267
1268 @item --srec-len=@var{ival}
1269 Meaningful only for srec output. Set the maximum length of the Srecords
1270 being produced to @var{ival}. This length covers both address, data and
1271 crc fields.
1272
1273 @item --srec-forceS3
1274 Meaningful only for srec output. Avoid generation of S1/S2 records,
1275 creating S3-only record format.
1276
1277 @item --redefine-sym @var{old}=@var{new}
1278 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1279 when one is trying link two things together for which you have no
1280 source, and there are name collisions.
1281
1282 @item --weaken
1283 Change all global symbols in the file to be weak. This can be useful
1284 when building an object which will be linked against other objects using
1285 the @option{-R} option to the linker. This option is only effective when
1286 using an object file format which supports weak symbols.
1287
1288 @item --keep-symbols=@var{filename}
1289 Apply @option{--keep-symbol} option to each symbol listed in the file
1290 @var{filename}. @var{filename} is simply a flat file, with one symbol
1291 name per line. Line comments may be introduced by the hash character.
1292 This option may be given more than once.
1293
1294 @item --strip-symbols=@var{filename}
1295 Apply @option{--strip-symbol} option to each symbol listed in the file
1296 @var{filename}. @var{filename} is simply a flat file, with one symbol
1297 name per line. Line comments may be introduced by the hash character.
1298 This option may be given more than once.
1299
1300 @item --keep-global-symbols=@var{filename}
1301 Apply @option{--keep-global-symbol} option to each symbol listed in the
1302 file @var{filename}. @var{filename} is simply a flat file, with one
1303 symbol name per line. Line comments may be introduced by the hash
1304 character. This option may be given more than once.
1305
1306 @item --localize-symbols=@var{filename}
1307 Apply @option{--localize-symbol} option to each symbol listed in the file
1308 @var{filename}. @var{filename} is simply a flat file, with one symbol
1309 name per line. Line comments may be introduced by the hash character.
1310 This option may be given more than once.
1311
1312 @item --weaken-symbols=@var{filename}
1313 Apply @option{--weaken-symbol} option to each symbol listed in the file
1314 @var{filename}. @var{filename} is simply a flat file, with one symbol
1315 name per line. Line comments may be introduced by the hash character.
1316 This option may be given more than once.
1317
1318 @item --alt-machine-code=@var{index}
1319 If the output architecture has alternate machine codes, use the
1320 @var{index}th code instead of the default one. This is useful in case
1321 a machine is assigned an official code and the tool-chain adopts the
1322 new code, but other applications still depend on the original code
1323 being used.
1324
1325 @item --prefix-symbols=@var{string}
1326 Prefix all symbols in the output file with @var{string}.
1327
1328 @item --prefix-sections=@var{string}
1329 Prefix all section names in the output file with @var{string}.
1330
1331 @item --prefix-alloc-sections=@var{string}
1332 Prefix all the names of all allocated sections in the output file with
1333 @var{string}.
1334
1335 @item -V
1336 @itemx --version
1337 Show the version number of @command{objcopy}.
1338
1339 @item -v
1340 @itemx --verbose
1341 Verbose output: list all object files modified. In the case of
1342 archives, @samp{objcopy -V} lists all members of the archive.
1343
1344 @item --help
1345 Show a summary of the options to @command{objcopy}.
1346 @end table
1347
1348 @c man end
1349
1350 @ignore
1351 @c man begin SEEALSO objcopy
1352 ld(1), objdump(1), and the Info entries for @file{binutils}.
1353 @c man end
1354 @end ignore
1355
1356 @node objdump
1357 @chapter objdump
1358
1359 @cindex object file information
1360 @kindex objdump
1361
1362 @c man title objdump display information from object files.
1363
1364 @smallexample
1365 @c man begin SYNOPSIS objdump
1366 objdump [@option{-a}|@option{--archive-headers}]
1367 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1368 [@option{-C}|@option{--demangle}[=@var{style}] ]
1369 [@option{-d}|@option{--disassemble}]
1370 [@option{-D}|@option{--disassemble-all}]
1371 [@option{-z}|@option{--disassemble-zeroes}]
1372 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1373 [@option{-f}|@option{--file-headers}]
1374 [@option{--file-start-context}]
1375 [@option{-g}|@option{--debugging}]
1376 [@option{-h}|@option{--section-headers}|@option{--headers}]
1377 [@option{-i}|@option{--info}]
1378 [@option{-j} @var{section}|@option{--section=}@var{section}]
1379 [@option{-l}|@option{--line-numbers}]
1380 [@option{-S}|@option{--source}]
1381 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1382 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1383 [@option{-p}|@option{--private-headers}]
1384 [@option{-r}|@option{--reloc}]
1385 [@option{-R}|@option{--dynamic-reloc}]
1386 [@option{-s}|@option{--full-contents}]
1387 [@option{-G}|@option{--stabs}]
1388 [@option{-t}|@option{--syms}]
1389 [@option{-T}|@option{--dynamic-syms}]
1390 [@option{-x}|@option{--all-headers}]
1391 [@option{-w}|@option{--wide}]
1392 [@option{--start-address=}@var{address}]
1393 [@option{--stop-address=}@var{address}]
1394 [@option{--prefix-addresses}]
1395 [@option{--[no-]show-raw-insn}]
1396 [@option{--adjust-vma=}@var{offset}]
1397 [@option{-V}|@option{--version}]
1398 [@option{-H}|@option{--help}]
1399 @var{objfile}@dots{}
1400 @c man end
1401 @end smallexample
1402
1403 @c man begin DESCRIPTION objdump
1404
1405 @command{objdump} displays information about one or more object files.
1406 The options control what particular information to display. This
1407 information is mostly useful to programmers who are working on the
1408 compilation tools, as opposed to programmers who just want their
1409 program to compile and work.
1410
1411 @var{objfile}@dots{} are the object files to be examined. When you
1412 specify archives, @command{objdump} shows information on each of the member
1413 object files.
1414
1415 @c man end
1416
1417 @c man begin OPTIONS objdump
1418
1419 The long and short forms of options, shown here as alternatives, are
1420 equivalent. At least one option from the list
1421 @option{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given.
1422
1423 @table @env
1424 @item -a
1425 @itemx --archive-header
1426 @cindex archive headers
1427 If any of the @var{objfile} files are archives, display the archive
1428 header information (in a format similar to @samp{ls -l}). Besides the
1429 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1430 the object file format of each archive member.
1431
1432 @item --adjust-vma=@var{offset}
1433 @cindex section addresses in objdump
1434 @cindex VMA in objdump
1435 When dumping information, first add @var{offset} to all the section
1436 addresses. This is useful if the section addresses do not correspond to
1437 the symbol table, which can happen when putting sections at particular
1438 addresses when using a format which can not represent section addresses,
1439 such as a.out.
1440
1441 @item -b @var{bfdname}
1442 @itemx --target=@var{bfdname}
1443 @cindex object code format
1444 Specify that the object-code format for the object files is
1445 @var{bfdname}. This option may not be necessary; @var{objdump} can
1446 automatically recognize many formats.
1447
1448 For example,
1449 @example
1450 objdump -b oasys -m vax -h fu.o
1451 @end example
1452 @noindent
1453 displays summary information from the section headers (@option{-h}) of
1454 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1455 file in the format produced by Oasys compilers. You can list the
1456 formats available with the @option{-i} option.
1457 @xref{Target Selection}, for more information.
1458
1459 @item -C
1460 @itemx --demangle[=@var{style}]
1461 @cindex demangling in objdump
1462 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1463 Besides removing any initial underscore prepended by the system, this
1464 makes C++ function names readable. Different compilers have different
1465 mangling styles. The optional demangling style argument can be used to
1466 choose an appropriate demangling style for your compiler. @xref{c++filt},
1467 for more information on demangling.
1468
1469 @item -G
1470 @item --debugging
1471 Display debugging information. This attempts to parse debugging
1472 information stored in the file and print it out using a C like syntax.
1473 Only certain types of debugging information have been implemented.
1474
1475 @item -d
1476 @itemx --disassemble
1477 @cindex disassembling object code
1478 @cindex machine instructions
1479 Display the assembler mnemonics for the machine instructions from
1480 @var{objfile}. This option only disassembles those sections which are
1481 expected to contain instructions.
1482
1483 @item -D
1484 @itemx --disassemble-all
1485 Like @option{-d}, but disassemble the contents of all sections, not just
1486 those expected to contain instructions.
1487
1488 @item --prefix-addresses
1489 When disassembling, print the complete address on each line. This is
1490 the older disassembly format.
1491
1492 @item -EB
1493 @itemx -EL
1494 @itemx --endian=@{big|little@}
1495 @cindex endianness
1496 @cindex disassembly endianness
1497 Specify the endianness of the object files. This only affects
1498 disassembly. This can be useful when disassembling a file format which
1499 does not describe endianness information, such as S-records.
1500
1501 @item -f
1502 @itemx --file-header
1503 @cindex object file header
1504 Display summary information from the overall header of
1505 each of the @var{objfile} files.
1506
1507 @item --file-start-context
1508 @cindex source code context
1509 Specify that when displaying interlisted source code/disassembly
1510 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1511 context to the start of the file.
1512
1513 @item -h
1514 @itemx --section-header
1515 @itemx --header
1516 @cindex section headers
1517 Display summary information from the section headers of the
1518 object file.
1519
1520 File segments may be relocated to nonstandard addresses, for example by
1521 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1522 @command{ld}. However, some object file formats, such as a.out, do not
1523 store the starting address of the file segments. In those situations,
1524 although @command{ld} relocates the sections correctly, using @samp{objdump
1525 -h} to list the file section headers cannot show the correct addresses.
1526 Instead, it shows the usual addresses, which are implicit for the
1527 target.
1528
1529 @item --help
1530 Print a summary of the options to @command{objdump} and exit.
1531
1532 @item -i
1533 @itemx --info
1534 @cindex architectures available
1535 @cindex object formats available
1536 Display a list showing all architectures and object formats available
1537 for specification with @option{-b} or @option{-m}.
1538
1539 @item -j @var{name}
1540 @itemx --section=@var{name}
1541 @cindex section information
1542 Display information only for section @var{name}.
1543
1544 @item -l
1545 @itemx --line-numbers
1546 @cindex source filenames for object files
1547 Label the display (using debugging information) with the filename and
1548 source line numbers corresponding to the object code or relocs shown.
1549 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1550
1551 @item -m @var{machine}
1552 @itemx --architecture=@var{machine}
1553 @cindex architecture
1554 @cindex disassembly architecture
1555 Specify the architecture to use when disassembling object files. This
1556 can be useful when disassembling object files which do not describe
1557 architecture information, such as S-records. You can list the available
1558 architectures with the @option{-i} option.
1559
1560 @item -M @var{options}
1561 @itemx --disassembler-options=@var{options}
1562 Pass target specific information to the disassembler. Only supported on
1563 some targets.
1564
1565 If the target is an ARM architecture then this switch can be used to
1566 select which register name set is used during disassembler. Specifying
1567 @option{-M reg-name-std} (the default) will select the register names as
1568 used in ARM's instruction set documentation, but with register 13 called
1569 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
1570 @option{-M reg-names-apcs} will select the name set used by the ARM
1571 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
1572 just use @samp{r} followed by the register number.
1573
1574 There are also two variants on the APCS register naming scheme enabled
1575 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
1576 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
1577 with the normal register name or the special register names).
1578
1579 This option can also be used for ARM architectures to force the
1580 disassembler to interpret all instructions as Thumb instructions by
1581 using the switch @option{--disassembler-options=force-thumb}. This can be
1582 useful when attempting to disassemble thumb code produced by other
1583 compilers.
1584
1585 For the x86, some of the options duplicate functions of the @option{-m}
1586 switch, but allow finer grained control. Multiple selections from the
1587 following may be specified as a comma separated string.
1588 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
1589 the given architecture. @option{intel} and @option{att} select between
1590 intel syntax mode and AT&T syntax mode. @option{addr32},
1591 @option{addr16}, @option{data32} and @option{data16} specify the default
1592 address size and operand size. These four options will be overridden if
1593 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
1594 option string. Lastly, @option{suffix}, when in AT&T mode,
1595 instructs the disassembler to print a mnemonic suffix even when the
1596 suffix could be inferred by the operands.
1597
1598 For PPC, @option{booke}, @option{booke32} and @option{booke64} select
1599 disassembly of BookE instructions. @option{32} and @option{64} select
1600 PowerPC and PowerPC64 disassembly, respectively.
1601
1602 For MIPS, this option controls the printing of register names in
1603 disassembled instructions. Multiple selections from the
1604 following may be specified as a comma separated string, and invalid
1605 options are ignored:
1606
1607 @table @code
1608 @item gpr-names=@var{ABI}
1609 Print GPR (general-purpose register) names as appropriate
1610 for the specified ABI. By default, GPR names are selected according to
1611 the ABI of the binary being disassembled.
1612
1613 @item fpr-names=@var{ABI}
1614 Print FPR (floating-point register) names as
1615 appropriate for the specified ABI. By default, FPR numbers are printed
1616 rather than names.
1617
1618 @item cp0-names=@var{ARCH}
1619 Print CP0 (system control coprocessor; coprocessor 0) register names
1620 as appropriate for the CPU or architecture specified by
1621 @var{ARCH}. By default, CP0 register names are selected according to
1622 the architecture and CPU of the binary being disassembled.
1623
1624 @item reg-names=@var{ABI}
1625 Print GPR and FPR names as appropriate for the selected ABI.
1626
1627 @item reg-names=@var{ARCH}
1628 Print CPU-specific register names (i.e., only the CP0 register names,
1629 for now) as appropriate for the selected CPU or architecture.
1630 @end table
1631
1632 For any of the options listed above, @var{ABI} or
1633 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
1634 rather than names, for the selected types of registers.
1635 You can list the available values of @var{ABI} and @var{ARCH} using
1636 the @option{--help} option.
1637
1638 @item -p
1639 @itemx --private-headers
1640 Print information that is specific to the object file format. The exact
1641 information printed depends upon the object file format. For some
1642 object file formats, no additional information is printed.
1643
1644 @item -r
1645 @itemx --reloc
1646 @cindex relocation entries, in object file
1647 Print the relocation entries of the file. If used with @option{-d} or
1648 @option{-D}, the relocations are printed interspersed with the
1649 disassembly.
1650
1651 @item -R
1652 @itemx --dynamic-reloc
1653 @cindex dynamic relocation entries, in object file
1654 Print the dynamic relocation entries of the file. This is only
1655 meaningful for dynamic objects, such as certain types of shared
1656 libraries.
1657
1658 @item -s
1659 @itemx --full-contents
1660 @cindex sections, full contents
1661 @cindex object file sections
1662 Display the full contents of any sections requested.
1663
1664 @item -S
1665 @itemx --source
1666 @cindex source disassembly
1667 @cindex disassembly, with source
1668 Display source code intermixed with disassembly, if possible. Implies
1669 @option{-d}.
1670
1671 @item --show-raw-insn
1672 When disassembling instructions, print the instruction in hex as well as
1673 in symbolic form. This is the default except when
1674 @option{--prefix-addresses} is used.
1675
1676 @item --no-show-raw-insn
1677 When disassembling instructions, do not print the instruction bytes.
1678 This is the default when @option{--prefix-addresses} is used.
1679
1680 @item -G
1681 @item --stabs
1682 @cindex stab
1683 @cindex .stab
1684 @cindex debug symbols
1685 @cindex ELF object file format
1686 Display the full contents of any sections requested. Display the
1687 contents of the .stab and .stab.index and .stab.excl sections from an
1688 ELF file. This is only useful on systems (such as Solaris 2.0) in which
1689 @code{.stab} debugging symbol-table entries are carried in an ELF
1690 section. In most other file formats, debugging symbol-table entries are
1691 interleaved with linkage symbols, and are visible in the @option{--syms}
1692 output.
1693 @ifclear man
1694 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1695 Overview,stabs.info, The ``stabs'' debug format}.
1696 @end ifclear
1697
1698 @item --start-address=@var{address}
1699 @cindex start-address
1700 Start displaying data at the specified address. This affects the output
1701 of the @option{-d}, @option{-r} and @option{-s} options.
1702
1703 @item --stop-address=@var{address}
1704 @cindex stop-address
1705 Stop displaying data at the specified address. This affects the output
1706 of the @option{-d}, @option{-r} and @option{-s} options.
1707
1708 @item -t
1709 @itemx --syms
1710 @cindex symbol table entries, printing
1711 Print the symbol table entries of the file.
1712 This is similar to the information provided by the @samp{nm} program.
1713
1714 @item -T
1715 @itemx --dynamic-syms
1716 @cindex dynamic symbol table entries, printing
1717 Print the dynamic symbol table entries of the file. This is only
1718 meaningful for dynamic objects, such as certain types of shared
1719 libraries. This is similar to the information provided by the @samp{nm}
1720 program when given the @option{-D} (@option{--dynamic}) option.
1721
1722 @item --version
1723 Print the version number of @command{objdump} and exit.
1724
1725 @item -x
1726 @itemx --all-header
1727 @cindex all header information, object file
1728 @cindex header information, all
1729 Display all available header information, including the symbol table and
1730 relocation entries. Using @option{-x} is equivalent to specifying all of
1731 @option{-a -f -h -r -t}.
1732
1733 @item -w
1734 @itemx --wide
1735 @cindex wide output, printing
1736 Format some lines for output devices that have more than 80 columns.
1737 Also do not truncate symbol names when they are displayed.
1738
1739 @item -z
1740 @itemx --disassemble-zeroes
1741 Normally the disassembly output will skip blocks of zeroes. This
1742 option directs the disassembler to disassemble those blocks, just like
1743 any other data.
1744 @end table
1745
1746 @c man end
1747
1748 @ignore
1749 @c man begin SEEALSO objdump
1750 nm(1), readelf(1), and the Info entries for @file{binutils}.
1751 @c man end
1752 @end ignore
1753
1754 @node ranlib
1755 @chapter ranlib
1756
1757 @kindex ranlib
1758 @cindex archive contents
1759 @cindex symbol index
1760
1761 @c man title ranlib generate index to archive.
1762
1763 @smallexample
1764 @c man begin SYNOPSIS ranlib
1765 ranlib [@option{-vV}] @var{archive}
1766 @c man end
1767 @end smallexample
1768
1769 @c man begin DESCRIPTION ranlib
1770
1771 @command{ranlib} generates an index to the contents of an archive and
1772 stores it in the archive. The index lists each symbol defined by a
1773 member of an archive that is a relocatable object file.
1774
1775 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
1776
1777 An archive with such an index speeds up linking to the library and
1778 allows routines in the library to call each other without regard to
1779 their placement in the archive.
1780
1781 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
1782 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
1783 @xref{ar}.
1784
1785 @c man end
1786
1787 @c man begin OPTIONS ranlib
1788
1789 @table @env
1790 @item -v
1791 @itemx -V
1792 @itemx --version
1793 Show the version number of @command{ranlib}.
1794 @end table
1795
1796 @c man end
1797
1798 @ignore
1799 @c man begin SEEALSO ranlib
1800 ar(1), nm(1), and the Info entries for @file{binutils}.
1801 @c man end
1802 @end ignore
1803
1804 @node size
1805 @chapter size
1806
1807 @kindex size
1808 @cindex section sizes
1809
1810 @c man title size list section sizes and total size.
1811
1812 @smallexample
1813 @c man begin SYNOPSIS size
1814 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
1815 [@option{--help}]
1816 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
1817 [@option{-t}|@option{--totals}]
1818 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
1819 [@var{objfile}@dots{}]
1820 @c man end
1821 @end smallexample
1822
1823 @c man begin DESCRIPTION size
1824
1825 The @sc{gnu} @command{size} utility lists the section sizes---and the total
1826 size---for each of the object or archive files @var{objfile} in its
1827 argument list. By default, one line of output is generated for each
1828 object file or each module in an archive.
1829
1830 @var{objfile}@dots{} are the object files to be examined.
1831 If none are specified, the file @code{a.out} will be used.
1832
1833 @c man end
1834
1835 @c man begin OPTIONS size
1836
1837 The command line options have the following meanings:
1838
1839 @table @env
1840 @item -A
1841 @itemx -B
1842 @itemx --format=@var{compatibility}
1843 @cindex @command{size} display format
1844 Using one of these options, you can choose whether the output from @sc{gnu}
1845 @command{size} resembles output from System V @command{size} (using @option{-A},
1846 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
1847 @option{--format=berkeley}). The default is the one-line format similar to
1848 Berkeley's.
1849 @c Bonus for doc-source readers: you can also say --format=strange (or
1850 @c anything else that starts with 's') for sysv, and --format=boring (or
1851 @c anything else that starts with 'b') for Berkeley.
1852
1853 Here is an example of the Berkeley (default) format of output from
1854 @command{size}:
1855 @smallexample
1856 $ size --format=Berkeley ranlib size
1857 text data bss dec hex filename
1858 294880 81920 11592 388392 5ed28 ranlib
1859 294880 81920 11888 388688 5ee50 size
1860 @end smallexample
1861
1862 @noindent
1863 This is the same data, but displayed closer to System V conventions:
1864
1865 @smallexample
1866 $ size --format=SysV ranlib size
1867 ranlib :
1868 section size addr
1869 .text 294880 8192
1870 .data 81920 303104
1871 .bss 11592 385024
1872 Total 388392
1873
1874
1875 size :
1876 section size addr
1877 .text 294880 8192
1878 .data 81920 303104
1879 .bss 11888 385024
1880 Total 388688
1881 @end smallexample
1882
1883 @item --help
1884 Show a summary of acceptable arguments and options.
1885
1886 @item -d
1887 @itemx -o
1888 @itemx -x
1889 @itemx --radix=@var{number}
1890 @cindex @command{size} number format
1891 @cindex radix for section sizes
1892 Using one of these options, you can control whether the size of each
1893 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
1894 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
1895 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
1896 values (8, 10, 16) are supported. The total size is always given in two
1897 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
1898 octal and hexadecimal if you're using @option{-o}.
1899
1900 @item -t
1901 @itemx --totals
1902 Show totals of all objects listed (Berkeley format listing mode only).
1903
1904 @item --target=@var{bfdname}
1905 @cindex object code format
1906 Specify that the object-code format for @var{objfile} is
1907 @var{bfdname}. This option may not be necessary; @command{size} can
1908 automatically recognize many formats.
1909 @xref{Target Selection}, for more information.
1910
1911 @item -V
1912 @itemx --version
1913 Display the version number of @command{size}.
1914 @end table
1915
1916 @c man end
1917
1918 @ignore
1919 @c man begin SEEALSO size
1920 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
1921 @c man end
1922 @end ignore
1923
1924 @node strings
1925 @chapter strings
1926 @kindex strings
1927 @cindex listings strings
1928 @cindex printing strings
1929 @cindex strings, printing
1930
1931 @c man title strings print the strings of printable characters in files.
1932
1933 @smallexample
1934 @c man begin SYNOPSIS strings
1935 strings [@option{-afov}] [@option{-}@var{min-len}]
1936 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
1937 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
1938 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
1939 [@option{-}] [@option{--all}] [@option{--print-file-name}]
1940 [@option{--target=}@var{bfdname}]
1941 [@option{--help}] [@option{--version}] @var{file}@dots{}
1942 @c man end
1943 @end smallexample
1944
1945 @c man begin DESCRIPTION strings
1946
1947 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
1948 character sequences that are at least 4 characters long (or the number
1949 given with the options below) and are followed by an unprintable
1950 character. By default, it only prints the strings from the initialized
1951 and loaded sections of object files; for other types of files, it prints
1952 the strings from the whole file.
1953
1954 @command{strings} is mainly useful for determining the contents of non-text
1955 files.
1956
1957 @c man end
1958
1959 @c man begin OPTIONS strings
1960
1961 @table @env
1962 @item -a
1963 @itemx --all
1964 @itemx -
1965 Do not scan only the initialized and loaded sections of object files;
1966 scan the whole files.
1967
1968 @item -f
1969 @itemx --print-file-name
1970 Print the name of the file before each string.
1971
1972 @item --help
1973 Print a summary of the program usage on the standard output and exit.
1974
1975 @item -@var{min-len}
1976 @itemx -n @var{min-len}
1977 @itemx --bytes=@var{min-len}
1978 Print sequences of characters that are at least @var{min-len} characters
1979 long, instead of the default 4.
1980
1981 @item -o
1982 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
1983 act like @samp{-t d} instead. Since we can not be compatible with both
1984 ways, we simply chose one.
1985
1986 @item -t @var{radix}
1987 @itemx --radix=@var{radix}
1988 Print the offset within the file before each string. The single
1989 character argument specifies the radix of the offset---@samp{o} for
1990 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1991
1992 @item -e @var{encoding}
1993 @itemx --encoding=@var{encoding}
1994 Select the character encoding of the strings that are to be found.
1995 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
1996 characters (ASCII, ISO 8859, etc., default), @samp{S} =
1997 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
1998 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
1999 littleendian. Useful for finding wide character strings.
2000
2001 @item --target=@var{bfdname}
2002 @cindex object code format
2003 Specify an object code format other than your system's default format.
2004 @xref{Target Selection}, for more information.
2005
2006 @item -v
2007 @itemx --version
2008 Print the program version number on the standard output and exit.
2009 @end table
2010
2011 @c man end
2012
2013 @ignore
2014 @c man begin SEEALSO strings
2015 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2016 and the Info entries for @file{binutils}.
2017 @c man end
2018 @end ignore
2019
2020 @node strip
2021 @chapter strip
2022
2023 @kindex strip
2024 @cindex removing symbols
2025 @cindex discarding symbols
2026 @cindex symbols, discarding
2027
2028 @c man title strip Discard symbols from object files.
2029
2030 @smallexample
2031 @c man begin SYNOPSIS strip
2032 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname} ]
2033 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname} ]
2034 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname} ]
2035 [@option{-s}|@option{--strip-all}] [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2036 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname} ]
2037 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname} ]
2038 [@option{-x}|@option{--discard-all} ] [@option{-X} |@option{--discard-locals}]
2039 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname} ]
2040 [@option{-o} @var{file} ] [@option{-p}|@option{--preserve-dates}]
2041 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}] [@option{--help}]
2042 @var{objfile}@dots{}
2043 @c man end
2044 @end smallexample
2045
2046 @c man begin DESCRIPTION strip
2047
2048 @sc{gnu} @command{strip} discards all symbols from object files
2049 @var{objfile}. The list of object files may include archives.
2050 At least one object file must be given.
2051
2052 @command{strip} modifies the files named in its argument,
2053 rather than writing modified copies under different names.
2054
2055 @c man end
2056
2057 @c man begin OPTIONS strip
2058
2059 @table @env
2060 @item -F @var{bfdname}
2061 @itemx --target=@var{bfdname}
2062 Treat the original @var{objfile} as a file with the object
2063 code format @var{bfdname}, and rewrite it in the same format.
2064 @xref{Target Selection}, for more information.
2065
2066 @item --help
2067 Show a summary of the options to @command{strip} and exit.
2068
2069 @item -I @var{bfdname}
2070 @itemx --input-target=@var{bfdname}
2071 Treat the original @var{objfile} as a file with the object
2072 code format @var{bfdname}.
2073 @xref{Target Selection}, for more information.
2074
2075 @item -O @var{bfdname}
2076 @itemx --output-target=@var{bfdname}
2077 Replace @var{objfile} with a file in the output format @var{bfdname}.
2078 @xref{Target Selection}, for more information.
2079
2080 @item -R @var{sectionname}
2081 @itemx --remove-section=@var{sectionname}
2082 Remove any section named @var{sectionname} from the output file. This
2083 option may be given more than once. Note that using this option
2084 inappropriately may make the output file unusable.
2085
2086 @item -s
2087 @itemx --strip-all
2088 Remove all symbols.
2089
2090 @item -g
2091 @itemx -S
2092 @itemx -d
2093 @itemx --strip-debug
2094 Remove debugging symbols only.
2095
2096 @item --strip-unneeded
2097 Remove all symbols that are not needed for relocation processing.
2098
2099 @item -K @var{symbolname}
2100 @itemx --keep-symbol=@var{symbolname}
2101 Keep only symbol @var{symbolname} from the source file. This option may
2102 be given more than once.
2103
2104 @item -N @var{symbolname}
2105 @itemx --strip-symbol=@var{symbolname}
2106 Remove symbol @var{symbolname} from the source file. This option may be
2107 given more than once, and may be combined with strip options other than
2108 @option{-K}.
2109
2110 @item -o @var{file}
2111 Put the stripped output in @var{file}, rather than replacing the
2112 existing file. When this argument is used, only one @var{objfile}
2113 argument may be specified.
2114
2115 @item -p
2116 @itemx --preserve-dates
2117 Preserve the access and modification dates of the file.
2118
2119 @item -x
2120 @itemx --discard-all
2121 Remove non-global symbols.
2122
2123 @item -X
2124 @itemx --discard-locals
2125 Remove compiler-generated local symbols.
2126 (These usually start with @samp{L} or @samp{.}.)
2127
2128 @item -V
2129 @itemx --version
2130 Show the version number for @command{strip}.
2131
2132 @item -v
2133 @itemx --verbose
2134 Verbose output: list all object files modified. In the case of
2135 archives, @samp{strip -v} lists all members of the archive.
2136 @end table
2137
2138 @c man end
2139
2140 @ignore
2141 @c man begin SEEALSO strip
2142 the Info entries for @file{binutils}.
2143 @c man end
2144 @end ignore
2145
2146 @node c++filt, addr2line, strip, Top
2147 @chapter c++filt
2148
2149 @kindex c++filt
2150 @cindex demangling C++ symbols
2151
2152 @c man title cxxfilt Demangle C++ and Java symbols.
2153
2154 @smallexample
2155 @c man begin SYNOPSIS cxxfilt
2156 c++filt [@option{-_}|@option{--strip-underscores}]
2157 [@option{-j}|@option{--java}]
2158 [@option{-n}|@option{--no-strip-underscores}]
2159 [@option{-s} @var{format}|@option{--format=}@var{format}]
2160 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2161 @c man end
2162 @end smallexample
2163
2164 @c man begin DESCRIPTION cxxfilt
2165
2166 @kindex cxxfilt
2167 The C++ and Java languages provides function overloading, which means
2168 that you can write many functions with the same name (providing each
2169 takes parameters of different types). All C++ and Java function names
2170 are encoded into a low-level assembly label (this process is known as
2171 @dfn{mangling}). The @command{c++filt}
2172 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2173 MS-DOS this program is named @command{cxxfilt}.}
2174 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2175 names into user-level names so that the linker can keep these overloaded
2176 functions from clashing.
2177
2178 Every alphanumeric word (consisting of letters, digits, underscores,
2179 dollars, or periods) seen in the input is a potential label. If the
2180 label decodes into a C++ name, the C++ name replaces the low-level
2181 name in the output.
2182
2183 You can use @command{c++filt} to decipher individual symbols:
2184
2185 @example
2186 c++filt @var{symbol}
2187 @end example
2188
2189 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2190 names from the standard input and writes the demangled names to the
2191 standard output. All results are printed on the standard output.
2192
2193 @c man end
2194
2195 @c man begin OPTIONS cxxfilt
2196
2197 @table @env
2198 @item -_
2199 @itemx --strip-underscores
2200 On some systems, both the C and C++ compilers put an underscore in front
2201 of every name. For example, the C name @code{foo} gets the low-level
2202 name @code{_foo}. This option removes the initial underscore. Whether
2203 @command{c++filt} removes the underscore by default is target dependent.
2204
2205 @item -j
2206 @itemx --java
2207 Prints demangled names using Java syntax. The default is to use C++
2208 syntax.
2209
2210 @item -n
2211 @itemx --no-strip-underscores
2212 Do not remove the initial underscore.
2213
2214 @item -s @var{format}
2215 @itemx --format=@var{format}
2216 @sc{gnu} @command{nm} can decode three different methods of mangling, used by
2217 different C++ compilers. The argument to this option selects which
2218 method it uses:
2219
2220 @table @code
2221 @item gnu
2222 the one used by the @sc{gnu} compiler (the default method)
2223 @item lucid
2224 the one used by the Lucid compiler
2225 @item arm
2226 the one specified by the C++ Annotated Reference Manual
2227 @item hp
2228 the one used by the HP compiler
2229 @item edg
2230 the one used by the EDG compiler
2231 @item gnu-v3
2232 the one used by the @sc{gnu} compiler with the new ABI.
2233 @end table
2234
2235 @item --help
2236 Print a summary of the options to @command{c++filt} and exit.
2237
2238 @item --version
2239 Print the version number of @command{c++filt} and exit.
2240 @end table
2241
2242 @c man end
2243
2244 @ignore
2245 @c man begin SEEALSO cxxfilt
2246 the Info entries for @file{binutils}.
2247 @c man end
2248 @end ignore
2249
2250 @quotation
2251 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
2252 user interface are subject to change in future releases. In particular,
2253 a command-line option may be required in the the future to decode a name
2254 passed as an argument on the command line; in other words,
2255
2256 @example
2257 c++filt @var{symbol}
2258 @end example
2259
2260 @noindent
2261 may in a future release become
2262
2263 @example
2264 c++filt @var{option} @var{symbol}
2265 @end example
2266 @end quotation
2267
2268 @node addr2line
2269 @chapter addr2line
2270
2271 @kindex addr2line
2272 @cindex address to file name and line number
2273
2274 @c man title addr2line convert addresses into file names and line numbers.
2275
2276 @smallexample
2277 @c man begin SYNOPSIS addr2line
2278 addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
2279 [@option{-C}|@option{--demangle}[=@var{style}]]
2280 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
2281 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
2282 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
2283 [addr addr @dots{}]
2284 @c man end
2285 @end smallexample
2286
2287 @c man begin DESCRIPTION addr2line
2288
2289 @command{addr2line} translates program addresses into file names and line
2290 numbers. Given an address and an executable, it uses the debugging
2291 information in the executable to figure out which file name and line
2292 number are associated with a given address.
2293
2294 The executable to use is specified with the @option{-e} option. The
2295 default is the file @file{a.out}.
2296
2297 @command{addr2line} has two modes of operation.
2298
2299 In the first, hexadecimal addresses are specified on the command line,
2300 and @command{addr2line} displays the file name and line number for each
2301 address.
2302
2303 In the second, @command{addr2line} reads hexadecimal addresses from
2304 standard input, and prints the file name and line number for each
2305 address on standard output. In this mode, @command{addr2line} may be used
2306 in a pipe to convert dynamically chosen addresses.
2307
2308 The format of the output is @samp{FILENAME:LINENO}. The file name and
2309 line number for each address is printed on a separate line. If the
2310 @command{-f} option is used, then each @samp{FILENAME:LINENO} line is
2311 preceded by a @samp{FUNCTIONNAME} line which is the name of the function
2312 containing the address.
2313
2314 If the file name or function name can not be determined,
2315 @command{addr2line} will print two question marks in their place. If the
2316 line number can not be determined, @command{addr2line} will print 0.
2317
2318 @c man end
2319
2320 @c man begin OPTIONS addr2line
2321
2322 The long and short forms of options, shown here as alternatives, are
2323 equivalent.
2324
2325 @table @env
2326 @item -b @var{bfdname}
2327 @itemx --target=@var{bfdname}
2328 @cindex object code format
2329 Specify that the object-code format for the object files is
2330 @var{bfdname}.
2331
2332 @item -C
2333 @itemx --demangle[=@var{style}]
2334 @cindex demangling in objdump
2335 Decode (@dfn{demangle}) low-level symbol names into user-level names.
2336 Besides removing any initial underscore prepended by the system, this
2337 makes C++ function names readable. Different compilers have different
2338 mangling styles. The optional demangling style argument can be used to
2339 choose an appropriate demangling style for your compiler. @xref{c++filt},
2340 for more information on demangling.
2341
2342 @item -e @var{filename}
2343 @itemx --exe=@var{filename}
2344 Specify the name of the executable for which addresses should be
2345 translated. The default file is @file{a.out}.
2346
2347 @item -f
2348 @itemx --functions
2349 Display function names as well as file and line number information.
2350
2351 @item -s
2352 @itemx --basenames
2353 Display only the base of each file name.
2354 @end table
2355
2356 @c man end
2357
2358 @ignore
2359 @c man begin SEEALSO addr2line
2360 Info entries for @file{binutils}.
2361 @c man end
2362 @end ignore
2363
2364 @node nlmconv
2365 @chapter nlmconv
2366
2367 @command{nlmconv} converts a relocatable object file into a NetWare
2368 Loadable Module.
2369
2370 @ignore
2371 @command{nlmconv} currently works with @samp{i386} object
2372 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
2373 object files in @sc{elf}, or @code{a.out} format@footnote{
2374 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
2375 format in the Binary File Descriptor library. It has only been tested
2376 with the above formats.}.
2377 @end ignore
2378
2379 @quotation
2380 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
2381 utilities, since it is only useful for NLM targets.
2382 @end quotation
2383
2384 @c man title nlmconv converts object code into an NLM.
2385
2386 @smallexample
2387 @c man begin SYNOPSIS nlmconv
2388 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
2389 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
2390 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
2391 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
2392 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2393 @var{infile} @var{outfile}
2394 @c man end
2395 @end smallexample
2396
2397 @c man begin DESCRIPTION nlmconv
2398
2399 @command{nlmconv} converts the relocatable @samp{i386} object file
2400 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
2401 reading @var{headerfile} for NLM header information. For instructions
2402 on writing the NLM command file language used in header files, see the
2403 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
2404 Development and Tools Overview}, which is part of the NLM Software
2405 Developer's Kit (``NLM SDK''), available from Novell, Inc.
2406 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
2407 @var{infile};
2408 @ifclear man
2409 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
2410 @end ifclear
2411
2412 @command{nlmconv} can perform a link step. In other words, you can list
2413 more than one object file for input if you list them in the definitions
2414 file (rather than simply specifying one input file on the command line).
2415 In this case, @command{nlmconv} calls the linker for you.
2416
2417 @c man end
2418
2419 @c man begin OPTIONS nlmconv
2420
2421 @table @env
2422 @item -I @var{bfdname}
2423 @itemx --input-target=@var{bfdname}
2424 Object format of the input file. @command{nlmconv} can usually determine
2425 the format of a given file (so no default is necessary).
2426 @xref{Target Selection}, for more information.
2427
2428 @item -O @var{bfdname}
2429 @itemx --output-target=@var{bfdname}
2430 Object format of the output file. @command{nlmconv} infers the output
2431 format based on the input format, e.g. for a @samp{i386} input file the
2432 output format is @samp{nlm32-i386}.
2433 @xref{Target Selection}, for more information.
2434
2435 @item -T @var{headerfile}
2436 @itemx --header-file=@var{headerfile}
2437 Reads @var{headerfile} for NLM header information. For instructions on
2438 writing the NLM command file language used in header files, see@ see the
2439 @samp{linkers} section, of the @cite{NLM Development and Tools
2440 Overview}, which is part of the NLM Software Developer's Kit, available
2441 from Novell, Inc.
2442
2443 @item -d
2444 @itemx --debug
2445 Displays (on standard error) the linker command line used by @command{nlmconv}.
2446
2447 @item -l @var{linker}
2448 @itemx --linker=@var{linker}
2449 Use @var{linker} for any linking. @var{linker} can be an absolute or a
2450 relative pathname.
2451
2452 @item -h
2453 @itemx --help
2454 Prints a usage summary.
2455
2456 @item -V
2457 @itemx --version
2458 Prints the version number for @command{nlmconv}.
2459 @end table
2460
2461 @c man end
2462
2463 @ignore
2464 @c man begin SEEALSO nlmconv
2465 the Info entries for @file{binutils}.
2466 @c man end
2467 @end ignore
2468
2469 @node windres
2470 @chapter windres
2471
2472 @command{windres} may be used to manipulate Windows resources.
2473
2474 @quotation
2475 @emph{Warning:} @command{windres} is not always built as part of the binary
2476 utilities, since it is only useful for Windows targets.
2477 @end quotation
2478
2479 @c man title windres manipulate Windows resources.
2480
2481 @smallexample
2482 @c man begin SYNOPSIS windres
2483 windres [options] [input-file] [output-file]
2484 @c man end
2485 @end smallexample
2486
2487 @c man begin DESCRIPTION windres
2488
2489 @command{windres} reads resources from an input file and copies them into
2490 an output file. Either file may be in one of three formats:
2491
2492 @table @code
2493 @item rc
2494 A text format read by the Resource Compiler.
2495
2496 @item res
2497 A binary format generated by the Resource Compiler.
2498
2499 @item coff
2500 A COFF object or executable.
2501 @end table
2502
2503 The exact description of these different formats is available in
2504 documentation from Microsoft.
2505
2506 When @command{windres} converts from the @code{rc} format to the @code{res}
2507 format, it is acting like the Windows Resource Compiler. When
2508 @command{windres} converts from the @code{res} format to the @code{coff}
2509 format, it is acting like the Windows @code{CVTRES} program.
2510
2511 When @command{windres} generates an @code{rc} file, the output is similar
2512 but not identical to the format expected for the input. When an input
2513 @code{rc} file refers to an external filename, an output @code{rc} file
2514 will instead include the file contents.
2515
2516 If the input or output format is not specified, @command{windres} will
2517 guess based on the file name, or, for the input file, the file contents.
2518 A file with an extension of @file{.rc} will be treated as an @code{rc}
2519 file, a file with an extension of @file{.res} will be treated as a
2520 @code{res} file, and a file with an extension of @file{.o} or
2521 @file{.exe} will be treated as a @code{coff} file.
2522
2523 If no output file is specified, @command{windres} will print the resources
2524 in @code{rc} format to standard output.
2525
2526 The normal use is for you to write an @code{rc} file, use @command{windres}
2527 to convert it to a COFF object file, and then link the COFF file into
2528 your application. This will make the resources described in the
2529 @code{rc} file available to Windows.
2530
2531 @c man end
2532
2533 @c man begin OPTIONS windres
2534
2535 @table @env
2536 @item -i @var{filename}
2537 @itemx --input @var{filename}
2538 The name of the input file. If this option is not used, then
2539 @command{windres} will use the first non-option argument as the input file
2540 name. If there are no non-option arguments, then @command{windres} will
2541 read from standard input. @command{windres} can not read a COFF file from
2542 standard input.
2543
2544 @item -o @var{filename}
2545 @itemx --output @var{filename}
2546 The name of the output file. If this option is not used, then
2547 @command{windres} will use the first non-option argument, after any used
2548 for the input file name, as the output file name. If there is no
2549 non-option argument, then @command{windres} will write to standard output.
2550 @command{windres} can not write a COFF file to standard output.
2551
2552 @item -I @var{format}
2553 @itemx --input-format @var{format}
2554 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
2555 @samp{coff}. If no input format is specified, @command{windres} will
2556 guess, as described above.
2557
2558 @item -O @var{format}
2559 @itemx --output-format @var{format}
2560 The output format to generate. @var{format} may be @samp{res},
2561 @samp{rc}, or @samp{coff}. If no output format is specified,
2562 @command{windres} will guess, as described above.
2563
2564 @item -F @var{target}
2565 @itemx --target @var{target}
2566 Specify the BFD format to use for a COFF file as input or output. This
2567 is a BFD target name; you can use the @option{--help} option to see a list
2568 of supported targets. Normally @command{windres} will use the default
2569 format, which is the first one listed by the @option{--help} option.
2570 @ifclear man
2571 @ref{Target Selection}.
2572 @end ifclear
2573
2574 @item --preprocessor @var{program}
2575 When @command{windres} reads an @code{rc} file, it runs it through the C
2576 preprocessor first. This option may be used to specify the preprocessor
2577 to use, including any leading arguments. The default preprocessor
2578 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
2579
2580 @item --include-dir @var{directory}
2581 Specify an include directory to use when reading an @code{rc} file.
2582 @command{windres} will pass this to the preprocessor as an @option{-I}
2583 option. @command{windres} will also search this directory when looking for
2584 files named in the @code{rc} file.
2585
2586 @item -D @var{target}
2587 @itemx --define @var{sym}[=@var{val}]
2588 Specify a @option{-D} option to pass to the preprocessor when reading an
2589 @code{rc} file.
2590
2591 @item -v
2592 Enable verbose mode. This tells you what the preprocessor is if you
2593 didn't specify one.
2594
2595 @item --language @var{val}
2596 Specify the default language to use when reading an @code{rc} file.
2597 @var{val} should be a hexadecimal language code. The low eight bits are
2598 the language, and the high eight bits are the sublanguage.
2599
2600 @item --use-temp-file
2601 Use a temporary file to instead of using popen to read the output of
2602 the preprocessor. Use this option if the popen implementation is buggy
2603 on the host (eg., certain non-English language versions of Windows 95 and
2604 Windows 98 are known to have buggy popen where the output will instead
2605 go the console).
2606
2607 @item --no-use-temp-file
2608 Use popen, not a temporary file, to read the output of the preprocessor.
2609 This is the default behaviour.
2610
2611 @item --help
2612 Prints a usage summary.
2613
2614 @item --version
2615 Prints the version number for @command{windres}.
2616
2617 @item --yydebug
2618 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
2619 this will turn on parser debugging.
2620 @end table
2621
2622 @c man end
2623
2624 @ignore
2625 @c man begin SEEALSO windres
2626 the Info entries for @file{binutils}.
2627 @c man end
2628 @end ignore
2629
2630 @node dlltool
2631 @chapter Create files needed to build and use DLLs
2632 @cindex DLL
2633 @kindex dlltool
2634
2635 @command{dlltool} may be used to create the files needed to build and use
2636 dynamic link libraries (DLLs).
2637
2638 @quotation
2639 @emph{Warning:} @command{dlltool} is not always built as part of the binary
2640 utilities, since it is only useful for those targets which support DLLs.
2641 @end quotation
2642
2643 @c man title dlltool Create files needed to build and use DLLs.
2644
2645 @smallexample
2646 @c man begin SYNOPSIS dlltool
2647 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
2648 [@option{-b}|@option{--base-file} @var{base-file-name}]
2649 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
2650 [@option{-z}|@option{--output-def} @var{def-file-name}]
2651 [@option{-l}|@option{--output-lib} @var{library-file-name}]
2652 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
2653 [@option{--exclude-symbols} @var{list}]
2654 [@option{--no-default-excludes}]
2655 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
2656 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
2657 [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}]
2658 [@option{-A}|@option{--add-stdcall-alias}]
2659 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
2660 [@option{-n}|@option{--nodelete}] [@option{-v}|@option{--verbose}]
2661 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
2662 [object-file @dots{}]
2663 @c man end
2664 @end smallexample
2665
2666 @c man begin DESCRIPTION dlltool
2667
2668 @command{dlltool} reads its inputs, which can come from the @option{-d} and
2669 @option{-b} options as well as object files specified on the command
2670 line. It then processes these inputs and if the @option{-e} option has
2671 been specified it creates a exports file. If the @option{-l} option
2672 has been specified it creates a library file and if the @option{-z} option
2673 has been specified it creates a def file. Any or all of the @option{-e},
2674 @option{-l} and @option{-z} options can be present in one invocation of
2675 dlltool.
2676
2677 When creating a DLL, along with the source for the DLL, it is necessary
2678 to have three other files. @command{dlltool} can help with the creation of
2679 these files.
2680
2681 The first file is a @samp{.def} file which specifies which functions are
2682 exported from the DLL, which functions the DLL imports, and so on. This
2683 is a text file and can be created by hand, or @command{dlltool} can be used
2684 to create it using the @option{-z} option. In this case @command{dlltool}
2685 will scan the object files specified on its command line looking for
2686 those functions which have been specially marked as being exported and
2687 put entries for them in the .def file it creates.
2688
2689 In order to mark a function as being exported from a DLL, it needs to
2690 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
2691 section of the object file. This can be done in C by using the
2692 asm() operator:
2693
2694 @smallexample
2695 asm (".section .drectve");
2696 asm (".ascii \"-export:my_func\"");
2697
2698 int my_func (void) @{ @dots{} @}
2699 @end smallexample
2700
2701 The second file needed for DLL creation is an exports file. This file
2702 is linked with the object files that make up the body of the DLL and it
2703 handles the interface between the DLL and the outside world. This is a
2704 binary file and it can be created by giving the @option{-e} option to
2705 @command{dlltool} when it is creating or reading in a .def file.
2706
2707 The third file needed for DLL creation is the library file that programs
2708 will link with in order to access the functions in the DLL. This file
2709 can be created by giving the @option{-l} option to dlltool when it
2710 is creating or reading in a .def file.
2711
2712 @command{dlltool} builds the library file by hand, but it builds the
2713 exports file by creating temporary files containing assembler statements
2714 and then assembling these. The @option{-S} command line option can be
2715 used to specify the path to the assembler that dlltool will use,
2716 and the @option{-f} option can be used to pass specific flags to that
2717 assembler. The @option{-n} can be used to prevent dlltool from deleting
2718 these temporary assembler files when it is done, and if @option{-n} is
2719 specified twice then this will prevent dlltool from deleting the
2720 temporary object files it used to build the library.
2721
2722 Here is an example of creating a DLL from a source file @samp{dll.c} and
2723 also creating a program (from an object file called @samp{program.o})
2724 that uses that DLL:
2725
2726 @smallexample
2727 gcc -c dll.c
2728 dlltool -e exports.o -l dll.lib dll.o
2729 gcc dll.o exports.o -o dll.dll
2730 gcc program.o dll.lib -o program
2731 @end smallexample
2732
2733 @c man end
2734
2735 @c man begin OPTIONS dlltool
2736
2737 The command line options have the following meanings:
2738
2739 @table @env
2740
2741 @item -d @var{filename}
2742 @itemx --input-def @var{filename}
2743 @cindex input .def file
2744 Specifies the name of a .def file to be read in and processed.
2745
2746 @item -b @var{filename}
2747 @itemx --base-file @var{filename}
2748 @cindex base files
2749 Specifies the name of a base file to be read in and processed. The
2750 contents of this file will be added to the relocation section in the
2751 exports file generated by dlltool.
2752
2753 @item -e @var{filename}
2754 @itemx --output-exp @var{filename}
2755 Specifies the name of the export file to be created by dlltool.
2756
2757 @item -z @var{filename}
2758 @itemx --output-def @var{filename}
2759 Specifies the name of the .def file to be created by dlltool.
2760
2761 @item -l @var{filename}
2762 @itemx --output-lib @var{filename}
2763 Specifies the name of the library file to be created by dlltool.
2764
2765 @item --export-all-symbols
2766 Treat all global and weak defined symbols found in the input object
2767 files as symbols to be exported. There is a small list of symbols which
2768 are not exported by default; see the @option{--no-default-excludes}
2769 option. You may add to the list of symbols to not export by using the
2770 @option{--exclude-symbols} option.
2771
2772 @item --no-export-all-symbols
2773 Only export symbols explicitly listed in an input .def file or in
2774 @samp{.drectve} sections in the input object files. This is the default
2775 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
2776 attributes in the source code.
2777
2778 @item --exclude-symbols @var{list}
2779 Do not export the symbols in @var{list}. This is a list of symbol names
2780 separated by comma or colon characters. The symbol names should not
2781 contain a leading underscore. This is only meaningful when
2782 @option{--export-all-symbols} is used.
2783
2784 @item --no-default-excludes
2785 When @option{--export-all-symbols} is used, it will by default avoid
2786 exporting certain special symbols. The current list of symbols to avoid
2787 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
2788 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
2789 to go ahead and export these special symbols. This is only meaningful
2790 when @option{--export-all-symbols} is used.
2791
2792 @item -S @var{path}
2793 @itemx --as @var{path}
2794 Specifies the path, including the filename, of the assembler to be used
2795 to create the exports file.
2796
2797 @item -f @var{options}
2798 @itemx --as-flags @var{options}
2799 Specifies any specific command line options to be passed to the
2800 assembler when building the exports file. This option will work even if
2801 the @option{-S} option is not used. This option only takes one argument,
2802 and if it occurs more than once on the command line, then later
2803 occurrences will override earlier occurrences. So if it is necessary to
2804 pass multiple options to the assembler they should be enclosed in
2805 double quotes.
2806
2807 @item -D @var{name}
2808 @itemx --dll-name @var{name}
2809 Specifies the name to be stored in the .def file as the name of the DLL
2810 when the @option{-e} option is used. If this option is not present, then
2811 the filename given to the @option{-e} option will be used as the name of
2812 the DLL.
2813
2814 @item -m @var{machine}
2815 @itemx -machine @var{machine}
2816 Specifies the type of machine for which the library file should be
2817 built. @command{dlltool} has a built in default type, depending upon how
2818 it was created, but this option can be used to override that. This is
2819 normally only useful when creating DLLs for an ARM processor, when the
2820 contents of the DLL are actually encode using Thumb instructions.
2821
2822 @item -a
2823 @itemx --add-indirect
2824 Specifies that when @command{dlltool} is creating the exports file it
2825 should add a section which allows the exported functions to be
2826 referenced without using the import library. Whatever the hell that
2827 means!
2828
2829 @item -U
2830 @itemx --add-underscore
2831 Specifies that when @command{dlltool} is creating the exports file it
2832 should prepend an underscore to the names of the exported functions.
2833
2834 @item -k
2835 @itemx --kill-at
2836 Specifies that when @command{dlltool} is creating the exports file it
2837 should not append the string @samp{@@ <number>}. These numbers are
2838 called ordinal numbers and they represent another way of accessing the
2839 function in a DLL, other than by name.
2840
2841 @item -A
2842 @itemx --add-stdcall-alias
2843 Specifies that when @command{dlltool} is creating the exports file it
2844 should add aliases for stdcall symbols without @samp{@@ <number>}
2845 in addition to the symbols with @samp{@@ <number>}.
2846
2847 @item -x
2848 @itemx --no-idata4
2849 Specifies that when @command{dlltool} is creating the exports and library
2850 files it should omit the @code{.idata4} section. This is for compatibility
2851 with certain operating systems.
2852
2853 @item -c
2854 @itemx --no-idata5
2855 Specifies that when @command{dlltool} is creating the exports and library
2856 files it should omit the @code{.idata5} section. This is for compatibility
2857 with certain operating systems.
2858
2859 @item -i
2860 @itemx --interwork
2861 Specifies that @command{dlltool} should mark the objects in the library
2862 file and exports file that it produces as supporting interworking
2863 between ARM and Thumb code.
2864
2865 @item -n
2866 @itemx --nodelete
2867 Makes @command{dlltool} preserve the temporary assembler files it used to
2868 create the exports file. If this option is repeated then dlltool will
2869 also preserve the temporary object files it uses to create the library
2870 file.
2871
2872 @item -v
2873 @itemx --verbose
2874 Make dlltool describe what it is doing.
2875
2876 @item -h
2877 @itemx --help
2878 Displays a list of command line options and then exits.
2879
2880 @item -V
2881 @itemx --version
2882 Displays dlltool's version number and then exits.
2883
2884 @end table
2885
2886 @c man end
2887
2888 @ignore
2889 @c man begin SEEALSO dlltool
2890 the Info entries for @file{binutils}.
2891 @c man end
2892 @end ignore
2893
2894 @node readelf
2895 @chapter readelf
2896
2897 @cindex ELF file information
2898 @kindex readelf
2899
2900 @c man title readelf Displays information about ELF files.
2901
2902 @smallexample
2903 @c man begin SYNOPSIS readelf
2904 readelf [@option{-a}|@option{--all}]
2905 [@option{-h}|@option{--file-header}]
2906 [@option{-l}|@option{--program-headers}|@option{--segments}]
2907 [@option{-S}|@option{--section-headers}|@option{--sections}]
2908 [@option{-e}|@option{--headers}]
2909 [@option{-s}|@option{--syms}|@option{--symbols}]
2910 [@option{-n}|@option{--notes}]
2911 [@option{-r}|@option{--relocs}]
2912 [@option{-u}|@option{--unwind}]
2913 [@option{-d}|@option{--dynamic}]
2914 [@option{-V}|@option{--version-info}]
2915 [@option{-D}|@option{--use-dynamic}]
2916 [@option{-x} <number>|@option{--hex-dump=}<number>]
2917 [@option{-w[liaprmfFso]}|@option{--debug-dump}[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames,=str,=loc]]
2918 [@option{-histogram}]
2919 [@option{-v}|@option{--version}]
2920 [@option{-W}|@option{--wide}]
2921 [@option{-H}|@option{--help}]
2922 @var{elffile}@dots{}
2923 @c man end
2924 @end smallexample
2925
2926 @c man begin DESCRIPTION readelf
2927
2928 @command{readelf} displays information about one or more ELF format object
2929 files. The options control what particular information to display.
2930
2931 @var{elffile}@dots{} are the object files to be examined. At the
2932 moment, @command{readelf} does not support examining archives, nor does it
2933 support examining 64 bit ELF files.
2934
2935 @c man end
2936
2937 @c man begin OPTIONS readelf
2938
2939 The long and short forms of options, shown here as alternatives, are
2940 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
2941 given.
2942
2943 @table @env
2944 @item -a
2945 @itemx --all
2946 Equivalent to specifiying @option{--file-header},
2947 @option{--program-headers}, @option{--sections}, @option{--symbols},
2948 @option{--relocs}, @option{--dynamic}, @option{--notes} and
2949 @option{--version-info}.
2950
2951 @item -h
2952 @itemx --file-header
2953 @cindex ELF file header information
2954 Displays the information contained in the ELF header at the start of the
2955 file.
2956
2957 @item -l
2958 @itemx --program-headers
2959 @itemx --segments
2960 @cindex ELF program header information
2961 @cindex ELF segment information
2962 Displays the information contained in the file's segment headers, if it
2963 has any.
2964
2965 @item -S
2966 @itemx --sections
2967 @itemx --section-headers
2968 @cindex ELF section information
2969 Displays the information contained in the file's section headers, if it
2970 has any.
2971
2972 @item -s
2973 @itemx --symbols
2974 @itemx --syms
2975 @cindex ELF symbol table information
2976 Displays the entries in symbol table section of the file, if it has one.
2977
2978 @item -e
2979 @itemx --headers
2980 Display all the headers in the file. Equivalent to @option{-h -l -S}.
2981
2982 @item -n
2983 @itemx --notes
2984 @cindex ELF core notes
2985 Displays the contents of the NOTE segment, if it exists.
2986
2987 @item -r
2988 @itemx --relocs
2989 @cindex ELF reloc information
2990 Displays the contents of the file's relocation section, if it has one.
2991
2992 @item -u
2993 @itemx --unwind
2994 @cindex unwind information
2995 Displays the contents of the file's unwind section, if it has one. Only
2996 the unwind sections for IA64 ELF files are currently supported.
2997
2998 @item -d
2999 @itemx --dynamic
3000 @cindex ELF dynamic section information
3001 Displays the contents of the file's dynamic section, if it has one.
3002
3003 @item -V
3004 @itemx --version-info
3005 @cindex ELF version sections informations
3006 Displays the contents of the version sections in the file, it they
3007 exist.
3008
3009 @item -D
3010 @itemx --use-dynamic
3011 When displaying symbols, this option makes @command{readelf} use the
3012 symbol table in the file's dynamic section, rather than the one in the
3013 symbols section.
3014
3015 @item -x <number>
3016 @itemx --hex-dump=<number>
3017 Displays the contents of the indicated section as a hexadecimal dump.
3018
3019 @item -w[liaprmfFso]
3020 @itemx --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=macro,=frames,=str,=loc]
3021 Displays the contents of the debug sections in the file, if any are
3022 present. If one of the optional letters or words follows the switch
3023 then only data found in those specific sections will be dumped.
3024
3025 @item --histogram
3026 Display a histogram of bucket list lengths when displaying the contents
3027 of the symbol tables.
3028
3029 @item -v
3030 @itemx --version
3031 Display the version number of readelf.
3032
3033 @item -W
3034 @itemx --wide
3035 Don't break output lines to fit into 80 columns. By default
3036 @command{readelf} breaks section header and segment listing lines for
3037 64-bit ELF files, so that they fit into 80 columns. This option causes
3038 @command{readelf} to print each section header resp. each segment one a
3039 single line, which is far more readable on terminals wider than 80 columns.
3040
3041 @item -H
3042 @itemx --help
3043 Display the command line options understood by @command{readelf}.
3044
3045 @end table
3046
3047 @c man end
3048
3049 @ignore
3050 @c man begin SEEALSO readelf
3051 objdump(1), and the Info entries for @file{binutils}.
3052 @c man end
3053 @end ignore
3054
3055 @node Selecting The Target System
3056 @chapter Selecting the target system
3057
3058 You can specify three aspects of the target system to the @sc{gnu}
3059 binary file utilities, each in several ways:
3060
3061 @itemize @bullet
3062 @item
3063 the target
3064
3065 @item
3066 the architecture
3067
3068 @item
3069 the linker emulation (which applies to the linker only)
3070 @end itemize
3071
3072 In the following summaries, the lists of ways to specify values are in
3073 order of decreasing precedence. The ways listed first override those
3074 listed later.
3075
3076 The commands to list valid values only list the values for which the
3077 programs you are running were configured. If they were configured with
3078 @option{--enable-targets=all}, the commands list most of the available
3079 values, but a few are left out; not all targets can be configured in at
3080 once because some of them can only be configured @dfn{native} (on hosts
3081 with the same type as the target system).
3082
3083 @menu
3084 * Target Selection::
3085 * Architecture Selection::
3086 * Linker Emulation Selection::
3087 @end menu
3088
3089 @node Target Selection
3090 @section Target Selection
3091
3092 A @dfn{target} is an object file format. A given target may be
3093 supported for multiple architectures (@pxref{Architecture Selection}).
3094 A target selection may also have variations for different operating
3095 systems or architectures.
3096
3097 The command to list valid target values is @samp{objdump -i}
3098 (the first column of output contains the relevant information).
3099
3100 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
3101 @samp{a.out-sunos-big}.
3102
3103 You can also specify a target using a configuration triplet. This is
3104 the same sort of name that is passed to @file{configure} to specify a
3105 target. When you use a configuration triplet as an argument, it must be
3106 fully canonicalized. You can see the canonical version of a triplet by
3107 running the shell script @file{config.sub} which is included with the
3108 sources.
3109
3110 Some sample configuration triplets are: @samp{m68k-hp-bsd},
3111 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
3112
3113 @subheading @command{objdump} Target
3114
3115 Ways to specify:
3116
3117 @enumerate
3118 @item
3119 command line option: @option{-b} or @option{--target}
3120
3121 @item
3122 environment variable @code{GNUTARGET}
3123
3124 @item
3125 deduced from the input file
3126 @end enumerate
3127
3128 @subheading @command{objcopy} and @command{strip} Input Target
3129
3130 Ways to specify:
3131
3132 @enumerate
3133 @item
3134 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
3135
3136 @item
3137 environment variable @code{GNUTARGET}
3138
3139 @item
3140 deduced from the input file
3141 @end enumerate
3142
3143 @subheading @command{objcopy} and @command{strip} Output Target
3144
3145 Ways to specify:
3146
3147 @enumerate
3148 @item
3149 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
3150
3151 @item
3152 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
3153
3154 @item
3155 environment variable @code{GNUTARGET}
3156
3157 @item
3158 deduced from the input file
3159 @end enumerate
3160
3161 @subheading @command{nm}, @command{size}, and @command{strings} Target
3162
3163 Ways to specify:
3164
3165 @enumerate
3166 @item
3167 command line option: @option{--target}
3168
3169 @item
3170 environment variable @code{GNUTARGET}
3171
3172 @item
3173 deduced from the input file
3174 @end enumerate
3175
3176 @subheading Linker Input Target
3177
3178 Ways to specify:
3179
3180 @enumerate
3181 @item
3182 command line option: @option{-b} or @option{--format}
3183 (@pxref{Options,,Options,ld.info,Using LD})
3184
3185 @item
3186 script command @code{TARGET}
3187 (@pxref{Format Commands,,Format Commands,ld.info,Using LD})
3188
3189 @item
3190 environment variable @code{GNUTARGET}
3191 (@pxref{Environment,,Environment,ld.info,Using LD})
3192
3193 @item
3194 the default target of the selected linker emulation
3195 (@pxref{Linker Emulation Selection})
3196 @end enumerate
3197
3198 @subheading Linker Output Target
3199
3200 Ways to specify:
3201
3202 @enumerate
3203 @item
3204 command line option: @option{-oformat}
3205 (@pxref{Options,,Options,ld.info,Using LD})
3206
3207 @item
3208 script command @code{OUTPUT_FORMAT}
3209 (@pxref{Format Commands,,Format Commands,ld.info,Using LD})
3210
3211 @item
3212 the linker input target (see ``Linker Input Target'' above)
3213 @end enumerate
3214
3215 @node Architecture Selection
3216 @section Architecture selection
3217
3218 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
3219 to run. Its name may contain a colon, separating the name of the
3220 processor family from the name of the particular @sc{cpu}.
3221
3222 The command to list valid architecture values is @samp{objdump -i} (the
3223 second column contains the relevant information).
3224
3225 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
3226
3227 @subheading @command{objdump} Architecture
3228
3229 Ways to specify:
3230
3231 @enumerate
3232 @item
3233 command line option: @option{-m} or @option{--architecture}
3234
3235 @item
3236 deduced from the input file
3237 @end enumerate
3238
3239 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
3240
3241 Ways to specify:
3242
3243 @enumerate
3244 @item
3245 deduced from the input file
3246 @end enumerate
3247
3248 @subheading Linker Input Architecture
3249
3250 Ways to specify:
3251
3252 @enumerate
3253 @item
3254 deduced from the input file
3255 @end enumerate
3256
3257 @subheading Linker Output Architecture
3258
3259 Ways to specify:
3260
3261 @enumerate
3262 @item
3263 script command @code{OUTPUT_ARCH}
3264 (@pxref{Miscellaneous Commands,,Miscellaneous Commands,ld.info,Using LD})
3265
3266 @item
3267 the default architecture from the linker output target
3268 (@pxref{Target Selection})
3269 @end enumerate
3270
3271 @node Linker Emulation Selection
3272 @section Linker emulation selection
3273
3274 A linker @dfn{emulation} is a ``personality'' of the linker, which gives
3275 the linker default values for the other aspects of the target system.
3276 In particular, it consists of
3277
3278 @itemize @bullet
3279 @item
3280 the linker script
3281
3282 @item
3283 the target
3284
3285 @item
3286 several ``hook'' functions that are run at certain stages of the linking
3287 process to do special things that some targets require
3288 @end itemize
3289
3290 The command to list valid linker emulation values is @samp{ld -V}.
3291
3292 Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
3293
3294 Ways to specify:
3295
3296 @enumerate
3297 @item
3298 command line option: @option{-m}
3299 (@pxref{Options,,Options,ld.info,Using LD})
3300
3301 @item
3302 environment variable @code{LDEMULATION}
3303
3304 @item
3305 compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
3306 which comes from @code{EMUL} in @file{config/@var{target}.mt}
3307 @end enumerate
3308
3309 @node Reporting Bugs
3310 @chapter Reporting Bugs
3311 @cindex bugs
3312 @cindex reporting bugs
3313
3314 Your bug reports play an essential role in making the binary utilities
3315 reliable.
3316
3317 Reporting a bug may help you by bringing a solution to your problem, or
3318 it may not. But in any case the principal function of a bug report is
3319 to help the entire community by making the next version of the binary
3320 utilities work better. Bug reports are your contribution to their
3321 maintenance.
3322
3323 In order for a bug report to serve its purpose, you must include the
3324 information that enables us to fix the bug.
3325
3326 @menu
3327 * Bug Criteria:: Have you found a bug?
3328 * Bug Reporting:: How to report bugs
3329 @end menu
3330
3331 @node Bug Criteria
3332 @section Have you found a bug?
3333 @cindex bug criteria
3334
3335 If you are not sure whether you have found a bug, here are some guidelines:
3336
3337 @itemize @bullet
3338 @cindex fatal signal
3339 @cindex crash
3340 @item
3341 If a binary utility gets a fatal signal, for any input whatever, that is
3342 a bug. Reliable utilities never crash.
3343
3344 @cindex error on valid input
3345 @item
3346 If a binary utility produces an error message for valid input, that is a
3347 bug.
3348
3349 @item
3350 If you are an experienced user of binary utilities, your suggestions for
3351 improvement are welcome in any case.
3352 @end itemize
3353
3354 @node Bug Reporting
3355 @section How to report bugs
3356 @cindex bug reports
3357 @cindex bugs, reporting
3358
3359 A number of companies and individuals offer support for @sc{gnu}
3360 products. If you obtained the binary utilities from a support
3361 organization, we recommend you contact that organization first.
3362
3363 You can find contact information for many support companies and
3364 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
3365 distribution.
3366
3367 In any event, we also recommend that you send bug reports for the binary
3368 utilities to @samp{bug-binutils@@gnu.org}.
3369
3370 The fundamental principle of reporting bugs usefully is this:
3371 @strong{report all the facts}. If you are not sure whether to state a
3372 fact or leave it out, state it!
3373
3374 Often people omit facts because they think they know what causes the
3375 problem and assume that some details do not matter. Thus, you might
3376 assume that the name of a file you use in an example does not matter.
3377 Well, probably it does not, but one cannot be sure. Perhaps the bug is
3378 a stray memory reference which happens to fetch from the location where
3379 that pathname is stored in memory; perhaps, if the pathname were
3380 different, the contents of that location would fool the utility into
3381 doing the right thing despite the bug. Play it safe and give a
3382 specific, complete example. That is the easiest thing for you to do,
3383 and the most helpful.
3384
3385 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
3386 it is new to us. Therefore, always write your bug reports on the assumption
3387 that the bug has not been reported previously.
3388
3389 Sometimes people give a few sketchy facts and ask, ``Does this ring a
3390 bell?'' Those bug reports are useless, and we urge everyone to
3391 @emph{refuse to respond to them} except to chide the sender to report
3392 bugs properly.
3393
3394 To enable us to fix the bug, you should include all these things:
3395
3396 @itemize @bullet
3397 @item
3398 The version of the utility. Each utility announces it if you start it
3399 with the @option{--version} argument.
3400
3401 Without this, we will not know whether there is any point in looking for
3402 the bug in the current version of the binary utilities.
3403
3404 @item
3405 Any patches you may have applied to the source, including any patches
3406 made to the @code{BFD} library.
3407
3408 @item
3409 The type of machine you are using, and the operating system name and
3410 version number.
3411
3412 @item
3413 What compiler (and its version) was used to compile the utilities---e.g.
3414 ``@code{gcc-2.7}''.
3415
3416 @item
3417 The command arguments you gave the utility to observe the bug. To
3418 guarantee you will not omit something important, list them all. A copy
3419 of the Makefile (or the output from make) is sufficient.
3420
3421 If we were to try to guess the arguments, we would probably guess wrong
3422 and then we might not encounter the bug.
3423
3424 @item
3425 A complete input file, or set of input files, that will reproduce the
3426 bug. If the utility is reading an object file or files, then it is
3427 generally most helpful to send the actual object files, uuencoded if
3428 necessary to get them through the mail system. Note that
3429 @samp{bug-binutils@@gnu.org} is a mailing list, so you should avoid
3430 sending very large files to it. Making the files available for
3431 anonymous FTP is OK.
3432
3433 If the source files were produced exclusively using @sc{gnu} programs
3434 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
3435 may be OK to send the source files rather than the object files. In
3436 this case, be sure to say exactly what version of @command{gcc}, or
3437 whatever, was used to produce the object files. Also say how
3438 @command{gcc}, or whatever, was configured.
3439
3440 @item
3441 A description of what behavior you observe that you believe is
3442 incorrect. For example, ``It gets a fatal signal.''
3443
3444 Of course, if the bug is that the utility gets a fatal signal, then we
3445 will certainly notice it. But if the bug is incorrect output, we might
3446 not notice unless it is glaringly wrong. You might as well not give us
3447 a chance to make a mistake.
3448
3449 Even if the problem you experience is a fatal signal, you should still
3450 say so explicitly. Suppose something strange is going on, such as your
3451 copy of the utility is out of synch, or you have encountered a bug in
3452 the C library on your system. (This has happened!) Your copy might
3453 crash and ours would not. If you told us to expect a crash, then when
3454 ours fails to crash, we would know that the bug was not happening for
3455 us. If you had not told us to expect a crash, then we would not be able
3456 to draw any conclusion from our observations.
3457
3458 @item
3459 If you wish to suggest changes to the source, send us context diffs, as
3460 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
3461 option. Always send diffs from the old file to the new file. If you
3462 wish to discuss something in the @command{ld} source, refer to it by
3463 context, not by line number.
3464
3465 The line numbers in our development sources will not match those in your
3466 sources. Your line numbers would convey no useful information to us.
3467 @end itemize
3468
3469 Here are some things that are not necessary:
3470
3471 @itemize @bullet
3472 @item
3473 A description of the envelope of the bug.
3474
3475 Often people who encounter a bug spend a lot of time investigating
3476 which changes to the input file will make the bug go away and which
3477 changes will not affect it.
3478
3479 This is often time consuming and not very useful, because the way we
3480 will find the bug is by running a single example under the debugger
3481 with breakpoints, not by pure deduction from a series of examples.
3482 We recommend that you save your time for something else.
3483
3484 Of course, if you can find a simpler example to report @emph{instead}
3485 of the original one, that is a convenience for us. Errors in the
3486 output will be easier to spot, running under the debugger will take
3487 less time, and so on.
3488
3489 However, simplification is not vital; if you do not want to do this,
3490 report the bug anyway and send us the entire test case you used.
3491
3492 @item
3493 A patch for the bug.
3494
3495 A patch for the bug does help us if it is a good one. But do not omit
3496 the necessary information, such as the test case, on the assumption that
3497 a patch is all we need. We might see problems with your patch and decide
3498 to fix the problem another way, or we might not understand it at all.
3499
3500 Sometimes with programs as complicated as the binary utilities it is
3501 very hard to construct an example that will make the program follow a
3502 certain path through the code. If you do not send us the example, we
3503 will not be able to construct one, so we will not be able to verify that
3504 the bug is fixed.
3505
3506 And if we cannot understand what bug you are trying to fix, or why your
3507 patch should be an improvement, we will not install it. A test case will
3508 help us to understand.
3509
3510 @item
3511 A guess about what the bug is or what it depends on.
3512
3513 Such guesses are usually wrong. Even we cannot guess right about such
3514 things without first using the debugger to find the facts.
3515 @end itemize
3516
3517 @node GNU Free Documentation License
3518 @chapter GNU Free Documentation License
3519 @cindex GNU Free Documentation License
3520
3521 GNU Free Documentation License
3522
3523 Version 1.1, March 2000
3524
3525 Copyright (C) 2000 Free Software Foundation, Inc.
3526 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
3527
3528 Everyone is permitted to copy and distribute verbatim copies
3529 of this license document, but changing it is not allowed.
3530
3531
3532 0. PREAMBLE
3533
3534 The purpose of this License is to make a manual, textbook, or other
3535 written document "free" in the sense of freedom: to assure everyone
3536 the effective freedom to copy and redistribute it, with or without
3537 modifying it, either commercially or noncommercially. Secondarily,
3538 this License preserves for the author and publisher a way to get
3539 credit for their work, while not being considered responsible for
3540 modifications made by others.
3541
3542 This License is a kind of "copyleft", which means that derivative
3543 works of the document must themselves be free in the same sense. It
3544 complements the GNU General Public License, which is a copyleft
3545 license designed for free software.
3546
3547 We have designed this License in order to use it for manuals for free
3548 software, because free software needs free documentation: a free
3549 program should come with manuals providing the same freedoms that the
3550 software does. But this License is not limited to software manuals;
3551 it can be used for any textual work, regardless of subject matter or
3552 whether it is published as a printed book. We recommend this License
3553 principally for works whose purpose is instruction or reference.
3554
3555
3556 1. APPLICABILITY AND DEFINITIONS
3557
3558 This License applies to any manual or other work that contains a
3559 notice placed by the copyright holder saying it can be distributed
3560 under the terms of this License. The "Document", below, refers to any
3561 such manual or work. Any member of the public is a licensee, and is
3562 addressed as "you".
3563
3564 A "Modified Version" of the Document means any work containing the
3565 Document or a portion of it, either copied verbatim, or with
3566 modifications and/or translated into another language.
3567
3568 A "Secondary Section" is a named appendix or a front-matter section of
3569 the Document that deals exclusively with the relationship of the
3570 publishers or authors of the Document to the Document's overall subject
3571 (or to related matters) and contains nothing that could fall directly
3572 within that overall subject. (For example, if the Document is in part a
3573 textbook of mathematics, a Secondary Section may not explain any
3574 mathematics.) The relationship could be a matter of historical
3575 connection with the subject or with related matters, or of legal,
3576 commercial, philosophical, ethical or political position regarding
3577 them.
3578
3579 The "Invariant Sections" are certain Secondary Sections whose titles
3580 are designated, as being those of Invariant Sections, in the notice
3581 that says that the Document is released under this License.
3582
3583 The "Cover Texts" are certain short passages of text that are listed,
3584 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
3585 the Document is released under this License.
3586
3587 A "Transparent" copy of the Document means a machine-readable copy,
3588 represented in a format whose specification is available to the
3589 general public, whose contents can be viewed and edited directly and
3590 straightforwardly with generic text editors or (for images composed of
3591 pixels) generic paint programs or (for drawings) some widely available
3592 drawing editor, and that is suitable for input to text formatters or
3593 for automatic translation to a variety of formats suitable for input
3594 to text formatters. A copy made in an otherwise Transparent file
3595 format whose markup has been designed to thwart or discourage
3596 subsequent modification by readers is not Transparent. A copy that is
3597 not "Transparent" is called "Opaque".
3598
3599 Examples of suitable formats for Transparent copies include plain
3600 ASCII without markup, Texinfo input format, LaTeX input format, SGML
3601 or XML using a publicly available DTD, and standard-conforming simple
3602 HTML designed for human modification. Opaque formats include
3603 PostScript, PDF, proprietary formats that can be read and edited only
3604 by proprietary word processors, SGML or XML for which the DTD and/or
3605 processing tools are not generally available, and the
3606 machine-generated HTML produced by some word processors for output
3607 purposes only.
3608
3609 The "Title Page" means, for a printed book, the title page itself,
3610 plus such following pages as are needed to hold, legibly, the material
3611 this License requires to appear in the title page. For works in
3612 formats which do not have any title page as such, "Title Page" means
3613 the text near the most prominent appearance of the work's title,
3614 preceding the beginning of the body of the text.
3615
3616
3617 2. VERBATIM COPYING
3618
3619 You may copy and distribute the Document in any medium, either
3620 commercially or noncommercially, provided that this License, the
3621 copyright notices, and the license notice saying this License applies
3622 to the Document are reproduced in all copies, and that you add no other
3623 conditions whatsoever to those of this License. You may not use
3624 technical measures to obstruct or control the reading or further
3625 copying of the copies you make or distribute. However, you may accept
3626 compensation in exchange for copies. If you distribute a large enough
3627 number of copies you must also follow the conditions in section 3.
3628
3629 You may also lend copies, under the same conditions stated above, and
3630 you may publicly display copies.
3631
3632
3633 3. COPYING IN QUANTITY
3634
3635 If you publish printed copies of the Document numbering more than 100,
3636 and the Document's license notice requires Cover Texts, you must enclose
3637 the copies in covers that carry, clearly and legibly, all these Cover
3638 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
3639 the back cover. Both covers must also clearly and legibly identify
3640 you as the publisher of these copies. The front cover must present
3641 the full title with all words of the title equally prominent and
3642 visible. You may add other material on the covers in addition.
3643 Copying with changes limited to the covers, as long as they preserve
3644 the title of the Document and satisfy these conditions, can be treated
3645 as verbatim copying in other respects.
3646
3647 If the required texts for either cover are too voluminous to fit
3648 legibly, you should put the first ones listed (as many as fit
3649 reasonably) on the actual cover, and continue the rest onto adjacent
3650 pages.
3651
3652 If you publish or distribute Opaque copies of the Document numbering
3653 more than 100, you must either include a machine-readable Transparent
3654 copy along with each Opaque copy, or state in or with each Opaque copy
3655 a publicly-accessible computer-network location containing a complete
3656 Transparent copy of the Document, free of added material, which the
3657 general network-using public has access to download anonymously at no
3658 charge using public-standard network protocols. If you use the latter
3659 option, you must take reasonably prudent steps, when you begin
3660 distribution of Opaque copies in quantity, to ensure that this
3661 Transparent copy will remain thus accessible at the stated location
3662 until at least one year after the last time you distribute an Opaque
3663 copy (directly or through your agents or retailers) of that edition to
3664 the public.
3665
3666 It is requested, but not required, that you contact the authors of the
3667 Document well before redistributing any large number of copies, to give
3668 them a chance to provide you with an updated version of the Document.
3669
3670
3671 4. MODIFICATIONS
3672
3673 You may copy and distribute a Modified Version of the Document under
3674 the conditions of sections 2 and 3 above, provided that you release
3675 the Modified Version under precisely this License, with the Modified
3676 Version filling the role of the Document, thus licensing distribution
3677 and modification of the Modified Version to whoever possesses a copy
3678 of it. In addition, you must do these things in the Modified Version:
3679
3680 A. Use in the Title Page (and on the covers, if any) a title distinct
3681 from that of the Document, and from those of previous versions
3682 (which should, if there were any, be listed in the History section
3683 of the Document). You may use the same title as a previous version
3684 if the original publisher of that version gives permission.
3685 B. List on the Title Page, as authors, one or more persons or entities
3686 responsible for authorship of the modifications in the Modified
3687 Version, together with at least five of the principal authors of the
3688 Document (all of its principal authors, if it has less than five).
3689 C. State on the Title page the name of the publisher of the
3690 Modified Version, as the publisher.
3691 D. Preserve all the copyright notices of the Document.
3692 E. Add an appropriate copyright notice for your modifications
3693 adjacent to the other copyright notices.
3694 F. Include, immediately after the copyright notices, a license notice
3695 giving the public permission to use the Modified Version under the
3696 terms of this License, in the form shown in the Addendum below.
3697 G. Preserve in that license notice the full lists of Invariant Sections
3698 and required Cover Texts given in the Document's license notice.
3699 H. Include an unaltered copy of this License.
3700 I. Preserve the section entitled "History", and its title, and add to
3701 it an item stating at least the title, year, new authors, and
3702 publisher of the Modified Version as given on the Title Page. If
3703 there is no section entitled "History" in the Document, create one
3704 stating the title, year, authors, and publisher of the Document as
3705 given on its Title Page, then add an item describing the Modified
3706 Version as stated in the previous sentence.
3707 J. Preserve the network location, if any, given in the Document for
3708 public access to a Transparent copy of the Document, and likewise
3709 the network locations given in the Document for previous versions
3710 it was based on. These may be placed in the "History" section.
3711 You may omit a network location for a work that was published at
3712 least four years before the Document itself, or if the original
3713 publisher of the version it refers to gives permission.
3714 K. In any section entitled "Acknowledgements" or "Dedications",
3715 preserve the section's title, and preserve in the section all the
3716 substance and tone of each of the contributor acknowledgements
3717 and/or dedications given therein.
3718 L. Preserve all the Invariant Sections of the Document,
3719 unaltered in their text and in their titles. Section numbers
3720 or the equivalent are not considered part of the section titles.
3721 M. Delete any section entitled "Endorsements". Such a section
3722 may not be included in the Modified Version.
3723 N. Do not retitle any existing section as "Endorsements"
3724 or to conflict in title with any Invariant Section.
3725
3726 If the Modified Version includes new front-matter sections or
3727 appendices that qualify as Secondary Sections and contain no material
3728 copied from the Document, you may at your option designate some or all
3729 of these sections as invariant. To do this, add their titles to the
3730 list of Invariant Sections in the Modified Version's license notice.
3731 These titles must be distinct from any other section titles.
3732
3733 You may add a section entitled "Endorsements", provided it contains
3734 nothing but endorsements of your Modified Version by various
3735 parties--for example, statements of peer review or that the text has
3736 been approved by an organization as the authoritative definition of a
3737 standard.
3738
3739 You may add a passage of up to five words as a Front-Cover Text, and a
3740 passage of up to 25 words as a Back-Cover Text, to the end of the list
3741 of Cover Texts in the Modified Version. Only one passage of
3742 Front-Cover Text and one of Back-Cover Text may be added by (or
3743 through arrangements made by) any one entity. If the Document already
3744 includes a cover text for the same cover, previously added by you or
3745 by arrangement made by the same entity you are acting on behalf of,
3746 you may not add another; but you may replace the old one, on explicit
3747 permission from the previous publisher that added the old one.
3748
3749 The author(s) and publisher(s) of the Document do not by this License
3750 give permission to use their names for publicity for or to assert or
3751 imply endorsement of any Modified Version.
3752
3753
3754 5. COMBINING DOCUMENTS
3755
3756 You may combine the Document with other documents released under this
3757 License, under the terms defined in section 4 above for modified
3758 versions, provided that you include in the combination all of the
3759 Invariant Sections of all of the original documents, unmodified, and
3760 list them all as Invariant Sections of your combined work in its
3761 license notice.
3762
3763 The combined work need only contain one copy of this License, and
3764 multiple identical Invariant Sections may be replaced with a single
3765 copy. If there are multiple Invariant Sections with the same name but
3766 different contents, make the title of each such section unique by
3767 adding at the end of it, in parentheses, the name of the original
3768 author or publisher of that section if known, or else a unique number.
3769 Make the same adjustment to the section titles in the list of
3770 Invariant Sections in the license notice of the combined work.
3771
3772 In the combination, you must combine any sections entitled "History"
3773 in the various original documents, forming one section entitled
3774 "History"; likewise combine any sections entitled "Acknowledgements",
3775 and any sections entitled "Dedications". You must delete all sections
3776 entitled "Endorsements."
3777
3778
3779 6. COLLECTIONS OF DOCUMENTS
3780
3781 You may make a collection consisting of the Document and other documents
3782 released under this License, and replace the individual copies of this
3783 License in the various documents with a single copy that is included in
3784 the collection, provided that you follow the rules of this License for
3785 verbatim copying of each of the documents in all other respects.
3786
3787 You may extract a single document from such a collection, and distribute
3788 it individually under this License, provided you insert a copy of this
3789 License into the extracted document, and follow this License in all
3790 other respects regarding verbatim copying of that document.
3791
3792
3793 7. AGGREGATION WITH INDEPENDENT WORKS
3794
3795 A compilation of the Document or its derivatives with other separate
3796 and independent documents or works, in or on a volume of a storage or
3797 distribution medium, does not as a whole count as a Modified Version
3798 of the Document, provided no compilation copyright is claimed for the
3799 compilation. Such a compilation is called an "aggregate", and this
3800 License does not apply to the other self-contained works thus compiled
3801 with the Document, on account of their being thus compiled, if they
3802 are not themselves derivative works of the Document.
3803
3804 If the Cover Text requirement of section 3 is applicable to these
3805 copies of the Document, then if the Document is less than one quarter
3806 of the entire aggregate, the Document's Cover Texts may be placed on
3807 covers that surround only the Document within the aggregate.
3808 Otherwise they must appear on covers around the whole aggregate.
3809
3810
3811 8. TRANSLATION
3812
3813 Translation is considered a kind of modification, so you may
3814 distribute translations of the Document under the terms of section 4.
3815 Replacing Invariant Sections with translations requires special
3816 permission from their copyright holders, but you may include
3817 translations of some or all Invariant Sections in addition to the
3818 original versions of these Invariant Sections. You may include a
3819 translation of this License provided that you also include the
3820 original English version of this License. In case of a disagreement
3821 between the translation and the original English version of this
3822 License, the original English version will prevail.
3823
3824
3825 9. TERMINATION
3826
3827 You may not copy, modify, sublicense, or distribute the Document except
3828 as expressly provided for under this License. Any other attempt to
3829 copy, modify, sublicense or distribute the Document is void, and will
3830 automatically terminate your rights under this License. However,
3831 parties who have received copies, or rights, from you under this
3832 License will not have their licenses terminated so long as such
3833 parties remain in full compliance.
3834
3835
3836 10. FUTURE REVISIONS OF THIS LICENSE
3837
3838 The Free Software Foundation may publish new, revised versions
3839 of the GNU Free Documentation License from time to time. Such new
3840 versions will be similar in spirit to the present version, but may
3841 differ in detail to address new problems or concerns. See
3842 http://www.gnu.org/copyleft/.
3843
3844 Each version of the License is given a distinguishing version number.
3845 If the Document specifies that a particular numbered version of this
3846 License "or any later version" applies to it, you have the option of
3847 following the terms and conditions either of that specified version or
3848 of any later version that has been published (not as a draft) by the
3849 Free Software Foundation. If the Document does not specify a version
3850 number of this License, you may choose any version ever published (not
3851 as a draft) by the Free Software Foundation.
3852
3853
3854 ADDENDUM: How to use this License for your documents
3855
3856 To use this License in a document you have written, include a copy of
3857 the License in the document and put the following copyright and
3858 license notices just after the title page:
3859
3860 @smallexample
3861 Copyright (c) YEAR YOUR NAME.
3862 Permission is granted to copy, distribute and/or modify this document
3863 under the terms of the GNU Free Documentation License, Version 1.1
3864 or any later version published by the Free Software Foundation;
3865 with the Invariant Sections being LIST THEIR TITLES, with the
3866 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
3867 A copy of the license is included in the section entitled "GNU
3868 Free Documentation License".
3869 @end smallexample
3870
3871 If you have no Invariant Sections, write "with no Invariant Sections"
3872 instead of saying which ones are invariant. If you have no
3873 Front-Cover Texts, write "no Front-Cover Texts" instead of
3874 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
3875
3876 If your document contains nontrivial examples of program code, we
3877 recommend releasing these examples in parallel under your choice of
3878 free software license, such as the GNU General Public License,
3879 to permit their use in free software.
3880
3881 @node Index
3882 @unnumbered Index
3883
3884 @printindex cp
3885
3886 @contents
3887 @bye
This page took 0.112028 seconds and 4 git commands to generate.