2012-05-08 Ben Cheng <bccheng@google.com>
[deliverable/binutils-gdb.git] / binutils / doc / binutils.texi
1 \input texinfo @c -*- Texinfo -*-
2 @setfilename binutils.info
3 @settitle @sc{gnu} Binary Utilities
4 @finalout
5 @synindex ky cp
6
7 @c man begin INCLUDE
8 @include bfdver.texi
9 @c man end
10
11 @copying
12 @c man begin COPYRIGHT
13 Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
14 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
15 2010, 2011, 2012
16 Free Software Foundation, Inc.
17
18 Permission is granted to copy, distribute and/or modify this document
19 under the terms of the GNU Free Documentation License, Version 1.3
20 or any later version published by the Free Software Foundation;
21 with no Invariant Sections, with no Front-Cover Texts, and with no
22 Back-Cover Texts. A copy of the license is included in the
23 section entitled ``GNU Free Documentation License''.
24
25 @c man end
26 @end copying
27
28 @dircategory Software development
29 @direntry
30 * Binutils: (binutils). The GNU binary utilities.
31 @end direntry
32
33 @dircategory Individual utilities
34 @direntry
35 * addr2line: (binutils)addr2line. Convert addresses to file and line.
36 * ar: (binutils)ar. Create, modify, and extract from archives.
37 * c++filt: (binutils)c++filt. Filter to demangle encoded C++ symbols.
38 * cxxfilt: (binutils)c++filt. MS-DOS name for c++filt.
39 * dlltool: (binutils)dlltool. Create files needed to build and use DLLs.
40 * nlmconv: (binutils)nlmconv. Converts object code into an NLM.
41 * nm: (binutils)nm. List symbols from object files.
42 * objcopy: (binutils)objcopy. Copy and translate object files.
43 * objdump: (binutils)objdump. Display information from object files.
44 * ranlib: (binutils)ranlib. Generate index to archive contents.
45 * readelf: (binutils)readelf. Display the contents of ELF format files.
46 * size: (binutils)size. List section sizes and total size.
47 * strings: (binutils)strings. List printable strings from files.
48 * strip: (binutils)strip. Discard symbols.
49 * elfedit: (binutils)elfedit. Update the ELF header of ELF files.
50 * windmc: (binutils)windmc. Generator for Windows message resources.
51 * windres: (binutils)windres. Manipulate Windows resources.
52 @end direntry
53
54 @titlepage
55 @title The @sc{gnu} Binary Utilities
56 @ifset VERSION_PACKAGE
57 @subtitle @value{VERSION_PACKAGE}
58 @end ifset
59 @subtitle Version @value{VERSION}
60 @sp 1
61 @subtitle @value{UPDATED}
62 @author Roland H. Pesch
63 @author Jeffrey M. Osier
64 @author Cygnus Support
65 @page
66
67 @tex
68 {\parskip=0pt \hfill Cygnus Support\par \hfill
69 Texinfo \texinfoversion\par }
70 @end tex
71
72 @vskip 0pt plus 1filll
73 @insertcopying
74 @end titlepage
75 @contents
76
77 @node Top
78 @top Introduction
79
80 @cindex version
81 This brief manual contains documentation for the @sc{gnu} binary
82 utilities
83 @ifset VERSION_PACKAGE
84 @value{VERSION_PACKAGE}
85 @end ifset
86 version @value{VERSION}:
87
88 @iftex
89 @table @code
90 @item ar
91 Create, modify, and extract from archives
92
93 @item nm
94 List symbols from object files
95
96 @item objcopy
97 Copy and translate object files
98
99 @item objdump
100 Display information from object files
101
102 @item ranlib
103 Generate index to archive contents
104
105 @item readelf
106 Display the contents of ELF format files.
107
108 @item size
109 List file section sizes and total size
110
111 @item strings
112 List printable strings from files
113
114 @item strip
115 Discard symbols
116
117 @item elfedit
118 Update the ELF header of ELF files.
119
120 @item c++filt
121 Demangle encoded C++ symbols (on MS-DOS, this program is named
122 @code{cxxfilt})
123
124 @item addr2line
125 Convert addresses into file names and line numbers
126
127 @item nlmconv
128 Convert object code into a Netware Loadable Module
129
130 @item windres
131 Manipulate Windows resources
132
133 @item windmc
134 Genertor for Windows message resources
135
136 @item dlltool
137 Create the files needed to build and use Dynamic Link Libraries
138 @end table
139 @end iftex
140
141 This document is distributed under the terms of the GNU Free
142 Documentation License version 1.3. A copy of the license is included
143 in the section entitled ``GNU Free Documentation License''.
144
145 @menu
146 * ar:: Create, modify, and extract from archives
147 * nm:: List symbols from object files
148 * objcopy:: Copy and translate object files
149 * objdump:: Display information from object files
150 * ranlib:: Generate index to archive contents
151 * readelf:: Display the contents of ELF format files
152 * size:: List section sizes and total size
153 * strings:: List printable strings from files
154 * strip:: Discard symbols
155 * elfedit:: Update the ELF header of ELF files
156 * c++filt:: Filter to demangle encoded C++ symbols
157 * cxxfilt: c++filt. MS-DOS name for c++filt
158 * addr2line:: Convert addresses to file and line
159 * nlmconv:: Converts object code into an NLM
160 * windres:: Manipulate Windows resources
161 * windmc:: Generator for Windows message resources
162 * dlltool:: Create files needed to build and use DLLs
163 * Common Options:: Command-line options for all utilities
164 * Selecting the Target System:: How these utilities determine the target
165 * Reporting Bugs:: Reporting Bugs
166 * GNU Free Documentation License:: GNU Free Documentation License
167 * Binutils Index:: Binutils Index
168 @end menu
169
170 @node ar
171 @chapter ar
172
173 @kindex ar
174 @cindex archives
175 @cindex collections of files
176
177 @c man title ar create, modify, and extract from archives
178
179 @smallexample
180 ar [@option{--plugin} @var{name}] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] [@option{--target} @var{bfdname}] @var{archive} [@var{member}@dots{}]
181 ar -M [ <mri-script ]
182 @end smallexample
183
184 @c man begin DESCRIPTION ar
185
186 The @sc{gnu} @command{ar} program creates, modifies, and extracts from
187 archives. An @dfn{archive} is a single file holding a collection of
188 other files in a structure that makes it possible to retrieve
189 the original individual files (called @dfn{members} of the archive).
190
191 The original files' contents, mode (permissions), timestamp, owner, and
192 group are preserved in the archive, and can be restored on
193 extraction.
194
195 @cindex name length
196 @sc{gnu} @command{ar} can maintain archives whose members have names of any
197 length; however, depending on how @command{ar} is configured on your
198 system, a limit on member-name length may be imposed for compatibility
199 with archive formats maintained with other tools. If it exists, the
200 limit is often 15 characters (typical of formats related to a.out) or 16
201 characters (typical of formats related to coff).
202
203 @cindex libraries
204 @command{ar} is considered a binary utility because archives of this sort
205 are most often used as @dfn{libraries} holding commonly needed
206 subroutines.
207
208 @cindex symbol index
209 @command{ar} creates an index to the symbols defined in relocatable
210 object modules in the archive when you specify the modifier @samp{s}.
211 Once created, this index is updated in the archive whenever @command{ar}
212 makes a change to its contents (save for the @samp{q} update operation).
213 An archive with such an index speeds up linking to the library, and
214 allows routines in the library to call each other without regard to
215 their placement in the archive.
216
217 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
218 table. If an archive lacks the table, another form of @command{ar} called
219 @command{ranlib} can be used to add just the table.
220
221 @cindex thin archives
222 @sc{gnu} @command{ar} can optionally create a @emph{thin} archive,
223 which contains a symbol index and references to the original copies
224 of the member files of the archives. Such an archive is useful
225 for building libraries for use within a local build, where the
226 relocatable objects are expected to remain available, and copying the
227 contents of each object would only waste time and space. Thin archives
228 are also @emph{flattened}, so that adding one or more archives to a
229 thin archive will add the elements of the nested archive individually.
230 The paths to the elements of the archive are stored relative to the
231 archive itself.
232
233 @cindex compatibility, @command{ar}
234 @cindex @command{ar} compatibility
235 @sc{gnu} @command{ar} is designed to be compatible with two different
236 facilities. You can control its activity using command-line options,
237 like the different varieties of @command{ar} on Unix systems; or, if you
238 specify the single command-line option @option{-M}, you can control it
239 with a script supplied via standard input, like the MRI ``librarian''
240 program.
241
242 @c man end
243
244 @menu
245 * ar cmdline:: Controlling @command{ar} on the command line
246 * ar scripts:: Controlling @command{ar} with a script
247 @end menu
248
249 @page
250 @node ar cmdline
251 @section Controlling @command{ar} on the Command Line
252
253 @smallexample
254 @c man begin SYNOPSIS ar
255 ar [@option{--plugin} @var{name}] [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] [@option{--target} @var{bfdname}] @var{archive} [@var{member}@dots{}]
256 @c man end
257 @end smallexample
258
259 @cindex Unix compatibility, @command{ar}
260 When you use @command{ar} in the Unix style, @command{ar} insists on at least two
261 arguments to execute: one keyletter specifying the @emph{operation}
262 (optionally accompanied by other keyletters specifying
263 @emph{modifiers}), and the archive name to act on.
264
265 Most operations can also accept further @var{member} arguments,
266 specifying particular files to operate on.
267
268 @c man begin OPTIONS ar
269
270 @sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
271 flags @var{mod} in any order, within the first command-line argument.
272
273 If you wish, you may begin the first command-line argument with a
274 dash.
275
276 @cindex operations on archive
277 The @var{p} keyletter specifies what operation to execute; it may be
278 any of the following, but you must specify only one of them:
279
280 @table @samp
281 @item d
282 @cindex deleting from archive
283 @emph{Delete} modules from the archive. Specify the names of modules to
284 be deleted as @var{member}@dots{}; the archive is untouched if you
285 specify no files to delete.
286
287 If you specify the @samp{v} modifier, @command{ar} lists each module
288 as it is deleted.
289
290 @item m
291 @cindex moving in archive
292 Use this operation to @emph{move} members in an archive.
293
294 The ordering of members in an archive can make a difference in how
295 programs are linked using the library, if a symbol is defined in more
296 than one member.
297
298 If no modifiers are used with @code{m}, any members you name in the
299 @var{member} arguments are moved to the @emph{end} of the archive;
300 you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
301 specified place instead.
302
303 @item p
304 @cindex printing from archive
305 @emph{Print} the specified members of the archive, to the standard
306 output file. If the @samp{v} modifier is specified, show the member
307 name before copying its contents to standard output.
308
309 If you specify no @var{member} arguments, all the files in the archive are
310 printed.
311
312 @item q
313 @cindex quick append to archive
314 @emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of
315 @var{archive}, without checking for replacement.
316
317 The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
318 operation; new members are always placed at the end of the archive.
319
320 The modifier @samp{v} makes @command{ar} list each file as it is appended.
321
322 Since the point of this operation is speed, the archive's symbol table
323 index is not updated, even if it already existed; you can use @samp{ar s} or
324 @command{ranlib} explicitly to update the symbol table index.
325
326 However, too many different systems assume quick append rebuilds the
327 index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
328
329 @item r
330 @cindex replacement in archive
331 Insert the files @var{member}@dots{} into @var{archive} (with
332 @emph{replacement}). This operation differs from @samp{q} in that any
333 previously existing members are deleted if their names match those being
334 added.
335
336 If one of the files named in @var{member}@dots{} does not exist, @command{ar}
337 displays an error message, and leaves undisturbed any existing members
338 of the archive matching that name.
339
340 By default, new members are added at the end of the file; but you may
341 use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
342 placement relative to some existing member.
343
344 The modifier @samp{v} used with this operation elicits a line of
345 output for each file inserted, along with one of the letters @samp{a} or
346 @samp{r} to indicate whether the file was appended (no old member
347 deleted) or replaced.
348
349 @item s
350 @cindex ranlib
351 Add an index to the archive, or update it if it already exists. Note
352 this command is an exception to the rule that there can only be one
353 command letter, as it is possible to use it as either a command or a
354 modifier. In either case it does the same thing.
355
356 @item t
357 @cindex contents of archive
358 Display a @emph{table} listing the contents of @var{archive}, or those
359 of the files listed in @var{member}@dots{} that are present in the
360 archive. Normally only the member name is shown; if you also want to
361 see the modes (permissions), timestamp, owner, group, and size, you can
362 request that by also specifying the @samp{v} modifier.
363
364 If you do not specify a @var{member}, all files in the archive
365 are listed.
366
367 @cindex repeated names in archive
368 @cindex name duplication in archive
369 If there is more than one file with the same name (say, @samp{fie}) in
370 an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
371 first instance; to see them all, you must ask for a complete
372 listing---in our example, @samp{ar t b.a}.
373 @c WRS only; per Gumby, this is implementation-dependent, and in a more
374 @c recent case in fact works the other way.
375
376 @item x
377 @cindex extract from archive
378 @emph{Extract} members (named @var{member}) from the archive. You can
379 use the @samp{v} modifier with this operation, to request that
380 @command{ar} list each name as it extracts it.
381
382 If you do not specify a @var{member}, all files in the archive
383 are extracted.
384
385 Files cannot be extracted from a thin archive.
386
387 @item --help
388 Displays the list of command line options supported by @command{ar}
389 and then exits.
390
391 @item --version
392 Displays the version information of @command{ar} and then exits.
393
394 @end table
395
396 A number of modifiers (@var{mod}) may immediately follow the @var{p}
397 keyletter, to specify variations on an operation's behavior:
398
399 @table @samp
400 @item a
401 @cindex relative placement in archive
402 Add new files @emph{after} an existing member of the
403 archive. If you use the modifier @samp{a}, the name of an existing archive
404 member must be present as the @var{relpos} argument, before the
405 @var{archive} specification.
406
407 @item b
408 Add new files @emph{before} an existing member of the
409 archive. If you use the modifier @samp{b}, the name of an existing archive
410 member must be present as the @var{relpos} argument, before the
411 @var{archive} specification. (same as @samp{i}).
412
413 @item c
414 @cindex creating archives
415 @emph{Create} the archive. The specified @var{archive} is always
416 created if it did not exist, when you request an update. But a warning is
417 issued unless you specify in advance that you expect to create it, by
418 using this modifier.
419
420 @item D
421 @cindex deterministic archives
422 @kindex --enable-deterministic-archives
423 Operate in @emph{deterministic} mode. When adding files and the archive
424 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
425 for all files. When this option is used, if @command{ar} is used with
426 identical options and identical input files, multiple runs will create
427 identical output files regardless of the input files' owners, groups,
428 file modes, or modification times.
429
430 If @file{binutils} was configured with
431 @option{--enable-deterministic-archives}, then this mode is on by default.
432 It can be disabled with the @samp{U} modifier, below.
433
434 @item f
435 Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
436 names of any length. This will cause it to create archives which are
437 not compatible with the native @command{ar} program on some systems. If
438 this is a concern, the @samp{f} modifier may be used to truncate file
439 names when putting them in the archive.
440
441 @item i
442 Insert new files @emph{before} an existing member of the
443 archive. If you use the modifier @samp{i}, the name of an existing archive
444 member must be present as the @var{relpos} argument, before the
445 @var{archive} specification. (same as @samp{b}).
446
447 @item l
448 This modifier is accepted but not used.
449 @c whaffor ar l modifier??? presumably compat; with
450 @c what???---doc@@cygnus.com, 25jan91
451
452 @item N
453 Uses the @var{count} parameter. This is used if there are multiple
454 entries in the archive with the same name. Extract or delete instance
455 @var{count} of the given name from the archive.
456
457 @item o
458 @cindex dates in archive
459 Preserve the @emph{original} dates of members when extracting them. If
460 you do not specify this modifier, files extracted from the archive
461 are stamped with the time of extraction.
462
463 @item P
464 Use the full path name when matching names in the archive. @sc{gnu}
465 @command{ar} can not create an archive with a full path name (such archives
466 are not POSIX complaint), but other archive creators can. This option
467 will cause @sc{gnu} @command{ar} to match file names using a complete path
468 name, which can be convenient when extracting a single file from an
469 archive created by another tool.
470
471 @item s
472 @cindex writing archive index
473 Write an object-file index into the archive, or update an existing one,
474 even if no other change is made to the archive. You may use this modifier
475 flag either with any operation, or alone. Running @samp{ar s} on an
476 archive is equivalent to running @samp{ranlib} on it.
477
478 @item S
479 @cindex not writing archive index
480 Do not generate an archive symbol table. This can speed up building a
481 large library in several steps. The resulting archive can not be used
482 with the linker. In order to build a symbol table, you must omit the
483 @samp{S} modifier on the last execution of @samp{ar}, or you must run
484 @samp{ranlib} on the archive.
485
486 @item T
487 @cindex creating thin archive
488 Make the specified @var{archive} a @emph{thin} archive. If it already
489 exists and is a regular archive, the existing members must be present
490 in the same directory as @var{archive}.
491
492 @item u
493 @cindex updating an archive
494 Normally, @samp{ar r}@dots{} inserts all files
495 listed into the archive. If you would like to insert @emph{only} those
496 of the files you list that are newer than existing members of the same
497 names, use this modifier. The @samp{u} modifier is allowed only for the
498 operation @samp{r} (replace). In particular, the combination @samp{qu} is
499 not allowed, since checking the timestamps would lose any speed
500 advantage from the operation @samp{q}.
501
502 @item U
503 @cindex deterministic archives
504 @kindex --enable-deterministic-archives
505 Do @emph{not} operate in @emph{deterministic} mode. This is the inverse
506 of the @samp{D} modifier, above: added files and the archive index will
507 get their actual UID, GID, timestamp, and file mode values.
508
509 This is the default unless @file{binutils} was configured with
510 @option{--enable-deterministic-archives}.
511
512 @item v
513 This modifier requests the @emph{verbose} version of an operation. Many
514 operations display additional information, such as filenames processed,
515 when the modifier @samp{v} is appended.
516
517 @item V
518 This modifier shows the version number of @command{ar}.
519 @end table
520
521 @command{ar} ignores an initial option spelt @samp{-X32_64}, for
522 compatibility with AIX. The behaviour produced by this option is the
523 default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
524 @samp{-X} options; in particular, it does not support @option{-X32}
525 which is the default for AIX @command{ar}.
526
527 The optional command line switch @option{--plugin} @var{name} causes
528 @command{ar} to load the plugin called @var{name} which adds support
529 for more file formats. This option is only available if the toolchain
530 has been built with plugin support enabled.
531
532 The optional command line switch @option{--target} @var{bfdname}
533 specifies that the archive members are in an object code format
534 different from your system's default format. See
535 @xref{Target Selection}, for more information.
536
537 @c man end
538
539 @ignore
540 @c man begin SEEALSO ar
541 nm(1), ranlib(1), and the Info entries for @file{binutils}.
542 @c man end
543 @end ignore
544
545 @node ar scripts
546 @section Controlling @command{ar} with a Script
547
548 @smallexample
549 ar -M [ <@var{script} ]
550 @end smallexample
551
552 @cindex MRI compatibility, @command{ar}
553 @cindex scripts, @command{ar}
554 If you use the single command-line option @samp{-M} with @command{ar}, you
555 can control its operation with a rudimentary command language. This
556 form of @command{ar} operates interactively if standard input is coming
557 directly from a terminal. During interactive use, @command{ar} prompts for
558 input (the prompt is @samp{AR >}), and continues executing even after
559 errors. If you redirect standard input to a script file, no prompts are
560 issued, and @command{ar} abandons execution (with a nonzero exit code)
561 on any error.
562
563 The @command{ar} command language is @emph{not} designed to be equivalent
564 to the command-line options; in fact, it provides somewhat less control
565 over archives. The only purpose of the command language is to ease the
566 transition to @sc{gnu} @command{ar} for developers who already have scripts
567 written for the MRI ``librarian'' program.
568
569 The syntax for the @command{ar} command language is straightforward:
570 @itemize @bullet
571 @item
572 commands are recognized in upper or lower case; for example, @code{LIST}
573 is the same as @code{list}. In the following descriptions, commands are
574 shown in upper case for clarity.
575
576 @item
577 a single command may appear on each line; it is the first word on the
578 line.
579
580 @item
581 empty lines are allowed, and have no effect.
582
583 @item
584 comments are allowed; text after either of the characters @samp{*}
585 or @samp{;} is ignored.
586
587 @item
588 Whenever you use a list of names as part of the argument to an @command{ar}
589 command, you can separate the individual names with either commas or
590 blanks. Commas are shown in the explanations below, for clarity.
591
592 @item
593 @samp{+} is used as a line continuation character; if @samp{+} appears
594 at the end of a line, the text on the following line is considered part
595 of the current command.
596 @end itemize
597
598 Here are the commands you can use in @command{ar} scripts, or when using
599 @command{ar} interactively. Three of them have special significance:
600
601 @code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
602 a temporary file required for most of the other commands.
603
604 @code{SAVE} commits the changes so far specified by the script. Prior
605 to @code{SAVE}, commands affect only the temporary copy of the current
606 archive.
607
608 @table @code
609 @item ADDLIB @var{archive}
610 @itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
611 Add all the contents of @var{archive} (or, if specified, each named
612 @var{module} from @var{archive}) to the current archive.
613
614 Requires prior use of @code{OPEN} or @code{CREATE}.
615
616 @item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
617 @c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
618 @c else like "ar q..."
619 Add each named @var{member} as a module in the current archive.
620
621 Requires prior use of @code{OPEN} or @code{CREATE}.
622
623 @item CLEAR
624 Discard the contents of the current archive, canceling the effect of
625 any operations since the last @code{SAVE}. May be executed (with no
626 effect) even if no current archive is specified.
627
628 @item CREATE @var{archive}
629 Creates an archive, and makes it the current archive (required for many
630 other commands). The new archive is created with a temporary name; it
631 is not actually saved as @var{archive} until you use @code{SAVE}.
632 You can overwrite existing archives; similarly, the contents of any
633 existing file named @var{archive} will not be destroyed until @code{SAVE}.
634
635 @item DELETE @var{module}, @var{module}, @dots{} @var{module}
636 Delete each listed @var{module} from the current archive; equivalent to
637 @samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
638
639 Requires prior use of @code{OPEN} or @code{CREATE}.
640
641 @item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
642 @itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
643 List each named @var{module} present in @var{archive}. The separate
644 command @code{VERBOSE} specifies the form of the output: when verbose
645 output is off, output is like that of @samp{ar -t @var{archive}
646 @var{module}@dots{}}. When verbose output is on, the listing is like
647 @samp{ar -tv @var{archive} @var{module}@dots{}}.
648
649 Output normally goes to the standard output stream; however, if you
650 specify @var{outputfile} as a final argument, @command{ar} directs the
651 output to that file.
652
653 @item END
654 Exit from @command{ar}, with a @code{0} exit code to indicate successful
655 completion. This command does not save the output file; if you have
656 changed the current archive since the last @code{SAVE} command, those
657 changes are lost.
658
659 @item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
660 Extract each named @var{module} from the current archive, writing them
661 into the current directory as separate files. Equivalent to @samp{ar -x
662 @var{archive} @var{module}@dots{}}.
663
664 Requires prior use of @code{OPEN} or @code{CREATE}.
665
666 @ignore
667 @c FIXME Tokens but no commands???
668 @item FULLDIR
669
670 @item HELP
671 @end ignore
672
673 @item LIST
674 Display full contents of the current archive, in ``verbose'' style
675 regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
676 tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
677 enhancement, rather than present for MRI compatibility.)
678
679 Requires prior use of @code{OPEN} or @code{CREATE}.
680
681 @item OPEN @var{archive}
682 Opens an existing archive for use as the current archive (required for
683 many other commands). Any changes as the result of subsequent commands
684 will not actually affect @var{archive} until you next use @code{SAVE}.
685
686 @item REPLACE @var{module}, @var{module}, @dots{} @var{module}
687 In the current archive, replace each existing @var{module} (named in
688 the @code{REPLACE} arguments) from files in the current working directory.
689 To execute this command without errors, both the file, and the module in
690 the current archive, must exist.
691
692 Requires prior use of @code{OPEN} or @code{CREATE}.
693
694 @item VERBOSE
695 Toggle an internal flag governing the output from @code{DIRECTORY}.
696 When the flag is on, @code{DIRECTORY} output matches output from
697 @samp{ar -tv }@dots{}.
698
699 @item SAVE
700 Commit your changes to the current archive, and actually save it as a
701 file with the name specified in the last @code{CREATE} or @code{OPEN}
702 command.
703
704 Requires prior use of @code{OPEN} or @code{CREATE}.
705
706 @end table
707
708 @iftex
709 @node ld
710 @chapter ld
711 @cindex linker
712 @kindex ld
713 The @sc{gnu} linker @command{ld} is now described in a separate manual.
714 @xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
715 @end iftex
716
717 @node nm
718 @chapter nm
719 @cindex symbols
720 @kindex nm
721
722 @c man title nm list symbols from object files
723
724 @smallexample
725 @c man begin SYNOPSIS nm
726 nm [@option{-a}|@option{--debug-syms}]
727 [@option{-g}|@option{--extern-only}][@option{--plugin} @var{name}]
728 [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
729 [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
730 [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
731 [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
732 [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
733 [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
734 [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
735 [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
736 [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
737 @c man end
738 @end smallexample
739
740 @c man begin DESCRIPTION nm
741 @sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
742 If no object files are listed as arguments, @command{nm} assumes the file
743 @file{a.out}.
744
745 For each symbol, @command{nm} shows:
746
747 @itemize @bullet
748 @item
749 The symbol value, in the radix selected by options (see below), or
750 hexadecimal by default.
751
752 @item
753 The symbol type. At least the following types are used; others are, as
754 well, depending on the object file format. If lowercase, the symbol is
755 usually local; if uppercase, the symbol is global (external). There
756 are however a few lowercase symbols that are shown for special global
757 symbols (@code{u}, @code{v} and @code{w}).
758
759 @c Some more detail on exactly what these symbol types are used for
760 @c would be nice.
761 @table @code
762 @item A
763 The symbol's value is absolute, and will not be changed by further
764 linking.
765
766 @item B
767 @itemx b
768 The symbol is in the uninitialized data section (known as BSS).
769
770 @item C
771 The symbol is common. Common symbols are uninitialized data. When
772 linking, multiple common symbols may appear with the same name. If the
773 symbol is defined anywhere, the common symbols are treated as undefined
774 references.
775 @ifclear man
776 For more details on common symbols, see the discussion of
777 --warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.
778 @end ifclear
779
780 @item D
781 @itemx d
782 The symbol is in the initialized data section.
783
784 @item G
785 @itemx g
786 The symbol is in an initialized data section for small objects. Some
787 object file formats permit more efficient access to small data objects,
788 such as a global int variable as opposed to a large global array.
789
790 @item i
791 For PE format files this indicates that the symbol is in a section
792 specific to the implementation of DLLs. For ELF format files this
793 indicates that the symbol is an indirect function. This is a GNU
794 extension to the standard set of ELF symbol types. It indicates a
795 symbol which if referenced by a relocation does not evaluate to its
796 address, but instead must be invoked at runtime. The runtime
797 execution will then return the value to be used in the relocation.
798
799 @item N
800 The symbol is a debugging symbol.
801
802 @item p
803 The symbols is in a stack unwind section.
804
805 @item R
806 @itemx r
807 The symbol is in a read only data section.
808
809 @item S
810 @itemx s
811 The symbol is in an uninitialized data section for small objects.
812
813 @item T
814 @itemx t
815 The symbol is in the text (code) section.
816
817 @item U
818 The symbol is undefined.
819
820 @item u
821 The symbol is a unique global symbol. This is a GNU extension to the
822 standard set of ELF symbol bindings. For such a symbol the dynamic linker
823 will make sure that in the entire process there is just one symbol with
824 this name and type in use.
825
826 @item V
827 @itemx v
828 The symbol is a weak object. When a weak defined symbol is linked with
829 a normal defined symbol, the normal defined symbol is used with no error.
830 When a weak undefined symbol is linked and the symbol is not defined,
831 the value of the weak symbol becomes zero with no error. On some
832 systems, uppercase indicates that a default value has been specified.
833
834 @item W
835 @itemx w
836 The symbol is a weak symbol that has not been specifically tagged as a
837 weak object symbol. When a weak defined symbol is linked with a normal
838 defined symbol, the normal defined symbol is used with no error.
839 When a weak undefined symbol is linked and the symbol is not defined,
840 the value of the symbol is determined in a system-specific manner without
841 error. On some systems, uppercase indicates that a default value has been
842 specified.
843
844 @item -
845 The symbol is a stabs symbol in an a.out object file. In this case, the
846 next values printed are the stabs other field, the stabs desc field, and
847 the stab type. Stabs symbols are used to hold debugging information.
848 @ifclear man
849 For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
850 ``stabs'' debug format}.
851 @end ifclear
852
853 @item ?
854 The symbol type is unknown, or object file format specific.
855 @end table
856
857 @item
858 The symbol name.
859 @end itemize
860
861 @c man end
862
863 @c man begin OPTIONS nm
864 The long and short forms of options, shown here as alternatives, are
865 equivalent.
866
867 @table @env
868 @item -A
869 @itemx -o
870 @itemx --print-file-name
871 @cindex input file name
872 @cindex file name
873 @cindex source file name
874 Precede each symbol by the name of the input file (or archive member)
875 in which it was found, rather than identifying the input file once only,
876 before all of its symbols.
877
878 @item -a
879 @itemx --debug-syms
880 @cindex debugging symbols
881 Display all symbols, even debugger-only symbols; normally these are not
882 listed.
883
884 @item -B
885 @cindex @command{nm} format
886 @cindex @command{nm} compatibility
887 The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
888
889 @item -C
890 @itemx --demangle[=@var{style}]
891 @cindex demangling in nm
892 Decode (@dfn{demangle}) low-level symbol names into user-level names.
893 Besides removing any initial underscore prepended by the system, this
894 makes C++ function names readable. Different compilers have different
895 mangling styles. The optional demangling style argument can be used to
896 choose an appropriate demangling style for your compiler. @xref{c++filt},
897 for more information on demangling.
898
899 @item --no-demangle
900 Do not demangle low-level symbol names. This is the default.
901
902 @item -D
903 @itemx --dynamic
904 @cindex dynamic symbols
905 Display the dynamic symbols rather than the normal symbols. This is
906 only meaningful for dynamic objects, such as certain types of shared
907 libraries.
908
909 @item -f @var{format}
910 @itemx --format=@var{format}
911 @cindex @command{nm} format
912 @cindex @command{nm} compatibility
913 Use the output format @var{format}, which can be @code{bsd},
914 @code{sysv}, or @code{posix}. The default is @code{bsd}.
915 Only the first character of @var{format} is significant; it can be
916 either upper or lower case.
917
918 @item -g
919 @itemx --extern-only
920 @cindex external symbols
921 Display only external symbols.
922
923 @item --plugin @var{name}
924 @cindex load plugin
925 Load the plugin called @var{name} to add support for extra target
926 types. This option is only available if the toolchain has been built
927 with plugin support enabled.
928
929 @item -l
930 @itemx --line-numbers
931 @cindex symbol line numbers
932 For each symbol, use debugging information to try to find a filename and
933 line number. For a defined symbol, look for the line number of the
934 address of the symbol. For an undefined symbol, look for the line
935 number of a relocation entry which refers to the symbol. If line number
936 information can be found, print it after the other symbol information.
937
938 @item -n
939 @itemx -v
940 @itemx --numeric-sort
941 Sort symbols numerically by their addresses, rather than alphabetically
942 by their names.
943
944 @item -p
945 @itemx --no-sort
946 @cindex sorting symbols
947 Do not bother to sort the symbols in any order; print them in the order
948 encountered.
949
950 @item -P
951 @itemx --portability
952 Use the POSIX.2 standard output format instead of the default format.
953 Equivalent to @samp{-f posix}.
954
955 @item -S
956 @itemx --print-size
957 Print both value and size of defined symbols for the @code{bsd} output style.
958 This option has no effect for object formats that do not record symbol
959 sizes, unless @samp{--size-sort} is also used in which case a
960 calculated size is displayed.
961
962 @item -s
963 @itemx --print-armap
964 @cindex symbol index, listing
965 When listing symbols from archive members, include the index: a mapping
966 (stored in the archive by @command{ar} or @command{ranlib}) of which modules
967 contain definitions for which names.
968
969 @item -r
970 @itemx --reverse-sort
971 Reverse the order of the sort (whether numeric or alphabetic); let the
972 last come first.
973
974 @item --size-sort
975 Sort symbols by size. The size is computed as the difference between
976 the value of the symbol and the value of the symbol with the next higher
977 value. If the @code{bsd} output format is used the size of the symbol
978 is printed, rather than the value, and @samp{-S} must be used in order
979 both size and value to be printed.
980
981 @item --special-syms
982 Display symbols which have a target-specific special meaning. These
983 symbols are usually used by the target for some special processing and
984 are not normally helpful when included included in the normal symbol
985 lists. For example for ARM targets this option would skip the mapping
986 symbols used to mark transitions between ARM code, THUMB code and
987 data.
988
989 @item -t @var{radix}
990 @itemx --radix=@var{radix}
991 Use @var{radix} as the radix for printing the symbol values. It must be
992 @samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
993
994 @item --target=@var{bfdname}
995 @cindex object code format
996 Specify an object code format other than your system's default format.
997 @xref{Target Selection}, for more information.
998
999 @item -u
1000 @itemx --undefined-only
1001 @cindex external symbols
1002 @cindex undefined symbols
1003 Display only undefined symbols (those external to each object file).
1004
1005 @item --defined-only
1006 @cindex external symbols
1007 @cindex undefined symbols
1008 Display only defined symbols for each object file.
1009
1010 @item -V
1011 @itemx --version
1012 Show the version number of @command{nm} and exit.
1013
1014 @item -X
1015 This option is ignored for compatibility with the AIX version of
1016 @command{nm}. It takes one parameter which must be the string
1017 @option{32_64}. The default mode of AIX @command{nm} corresponds
1018 to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
1019
1020 @item --help
1021 Show a summary of the options to @command{nm} and exit.
1022 @end table
1023
1024 @c man end
1025
1026 @ignore
1027 @c man begin SEEALSO nm
1028 ar(1), objdump(1), ranlib(1), and the Info entries for @file{binutils}.
1029 @c man end
1030 @end ignore
1031
1032 @node objcopy
1033 @chapter objcopy
1034
1035 @c man title objcopy copy and translate object files
1036
1037 @smallexample
1038 @c man begin SYNOPSIS objcopy
1039 objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
1040 [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
1041 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
1042 [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
1043 [@option{-S}|@option{--strip-all}]
1044 [@option{-g}|@option{--strip-debug}]
1045 [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
1046 [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
1047 [@option{--strip-unneeded-symbol=}@var{symbolname}]
1048 [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
1049 [@option{--localize-hidden}]
1050 [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
1051 [@option{--globalize-symbol=}@var{symbolname}]
1052 [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
1053 [@option{-w}|@option{--wildcard}]
1054 [@option{-x}|@option{--discard-all}]
1055 [@option{-X}|@option{--discard-locals}]
1056 [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
1057 [@option{-i} [@var{breadth}]|@option{--interleave}[=@var{breadth}]]
1058 [@option{--interleave-width=}@var{width}]
1059 [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
1060 [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
1061 [@option{-p}|@option{--preserve-dates}]
1062 [@option{-D}|@option{--enable-deterministic-archives}]
1063 [@option{--debugging}]
1064 [@option{--gap-fill=}@var{val}]
1065 [@option{--pad-to=}@var{address}]
1066 [@option{--set-start=}@var{val}]
1067 [@option{--adjust-start=}@var{incr}]
1068 [@option{--change-addresses=}@var{incr}]
1069 [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
1070 [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
1071 [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
1072 [@option{--change-warnings}] [@option{--no-change-warnings}]
1073 [@option{--set-section-flags} @var{section}=@var{flags}]
1074 [@option{--add-section} @var{sectionname}=@var{filename}]
1075 [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
1076 [@option{--long-section-names} @{enable,disable,keep@}]
1077 [@option{--change-leading-char}] [@option{--remove-leading-char}]
1078 [@option{--reverse-bytes=}@var{num}]
1079 [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
1080 [@option{--redefine-sym} @var{old}=@var{new}]
1081 [@option{--redefine-syms=}@var{filename}]
1082 [@option{--weaken}]
1083 [@option{--keep-symbols=}@var{filename}]
1084 [@option{--strip-symbols=}@var{filename}]
1085 [@option{--strip-unneeded-symbols=}@var{filename}]
1086 [@option{--keep-global-symbols=}@var{filename}]
1087 [@option{--localize-symbols=}@var{filename}]
1088 [@option{--globalize-symbols=}@var{filename}]
1089 [@option{--weaken-symbols=}@var{filename}]
1090 [@option{--alt-machine-code=}@var{index}]
1091 [@option{--prefix-symbols=}@var{string}]
1092 [@option{--prefix-sections=}@var{string}]
1093 [@option{--prefix-alloc-sections=}@var{string}]
1094 [@option{--add-gnu-debuglink=}@var{path-to-file}]
1095 [@option{--keep-file-symbols}]
1096 [@option{--only-keep-debug}]
1097 [@option{--extract-symbol}]
1098 [@option{--writable-text}]
1099 [@option{--readonly-text}]
1100 [@option{--pure}]
1101 [@option{--impure}]
1102 [@option{--file-alignment=}@var{num}]
1103 [@option{--heap=}@var{size}]
1104 [@option{--image-base=}@var{address}]
1105 [@option{--section-alignment=}@var{num}]
1106 [@option{--stack=}@var{size}]
1107 [@option{--subsystem=}@var{which}:@var{major}.@var{minor}]
1108 [@option{--compress-debug-sections}]
1109 [@option{--decompress-debug-sections}]
1110 [@option{--dwarf-depth=@var{n}}]
1111 [@option{--dwarf-start=@var{n}}]
1112 [@option{-v}|@option{--verbose}]
1113 [@option{-V}|@option{--version}]
1114 [@option{--help}] [@option{--info}]
1115 @var{infile} [@var{outfile}]
1116 @c man end
1117 @end smallexample
1118
1119 @c man begin DESCRIPTION objcopy
1120 The @sc{gnu} @command{objcopy} utility copies the contents of an object
1121 file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
1122 read and write the object files. It can write the destination object
1123 file in a format different from that of the source object file. The
1124 exact behavior of @command{objcopy} is controlled by command-line options.
1125 Note that @command{objcopy} should be able to copy a fully linked file
1126 between any two formats. However, copying a relocatable object file
1127 between any two formats may not work as expected.
1128
1129 @command{objcopy} creates temporary files to do its translations and
1130 deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
1131 translation work; it has access to all the formats described in @sc{bfd}
1132 and thus is able to recognize most formats without being told
1133 explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
1134
1135 @command{objcopy} can be used to generate S-records by using an output
1136 target of @samp{srec} (e.g., use @samp{-O srec}).
1137
1138 @command{objcopy} can be used to generate a raw binary file by using an
1139 output target of @samp{binary} (e.g., use @option{-O binary}). When
1140 @command{objcopy} generates a raw binary file, it will essentially produce
1141 a memory dump of the contents of the input object file. All symbols and
1142 relocation information will be discarded. The memory dump will start at
1143 the load address of the lowest section copied into the output file.
1144
1145 When generating an S-record or a raw binary file, it may be helpful to
1146 use @option{-S} to remove sections containing debugging information. In
1147 some cases @option{-R} will be useful to remove sections which contain
1148 information that is not needed by the binary file.
1149
1150 Note---@command{objcopy} is not able to change the endianness of its input
1151 files. If the input format has an endianness (some formats do not),
1152 @command{objcopy} can only copy the inputs into file formats that have the
1153 same endianness or which have no endianness (e.g., @samp{srec}).
1154 (However, see the @option{--reverse-bytes} option.)
1155
1156 @c man end
1157
1158 @c man begin OPTIONS objcopy
1159
1160 @table @env
1161 @item @var{infile}
1162 @itemx @var{outfile}
1163 The input and output files, respectively.
1164 If you do not specify @var{outfile}, @command{objcopy} creates a
1165 temporary file and destructively renames the result with
1166 the name of @var{infile}.
1167
1168 @item -I @var{bfdname}
1169 @itemx --input-target=@var{bfdname}
1170 Consider the source file's object format to be @var{bfdname}, rather than
1171 attempting to deduce it. @xref{Target Selection}, for more information.
1172
1173 @item -O @var{bfdname}
1174 @itemx --output-target=@var{bfdname}
1175 Write the output file using the object format @var{bfdname}.
1176 @xref{Target Selection}, for more information.
1177
1178 @item -F @var{bfdname}
1179 @itemx --target=@var{bfdname}
1180 Use @var{bfdname} as the object format for both the input and the output
1181 file; i.e., simply transfer data from source to destination with no
1182 translation. @xref{Target Selection}, for more information.
1183
1184 @item -B @var{bfdarch}
1185 @itemx --binary-architecture=@var{bfdarch}
1186 Useful when transforming a architecture-less input file into an object file.
1187 In this case the output architecture can be set to @var{bfdarch}. This
1188 option will be ignored if the input file has a known @var{bfdarch}. You
1189 can access this binary data inside a program by referencing the special
1190 symbols that are created by the conversion process. These symbols are
1191 called _binary_@var{objfile}_start, _binary_@var{objfile}_end and
1192 _binary_@var{objfile}_size. e.g. you can transform a picture file into
1193 an object file and then access it in your code using these symbols.
1194
1195 @item -j @var{sectionname}
1196 @itemx --only-section=@var{sectionname}
1197 Copy only the named section from the input file to the output file.
1198 This option may be given more than once. Note that using this option
1199 inappropriately may make the output file unusable.
1200
1201 @item -R @var{sectionname}
1202 @itemx --remove-section=@var{sectionname}
1203 Remove any section named @var{sectionname} from the output file. This
1204 option may be given more than once. Note that using this option
1205 inappropriately may make the output file unusable.
1206
1207 @item -S
1208 @itemx --strip-all
1209 Do not copy relocation and symbol information from the source file.
1210
1211 @item -g
1212 @itemx --strip-debug
1213 Do not copy debugging symbols or sections from the source file.
1214
1215 @item --strip-unneeded
1216 Strip all symbols that are not needed for relocation processing.
1217
1218 @item -K @var{symbolname}
1219 @itemx --keep-symbol=@var{symbolname}
1220 When stripping symbols, keep symbol @var{symbolname} even if it would
1221 normally be stripped. This option may be given more than once.
1222
1223 @item -N @var{symbolname}
1224 @itemx --strip-symbol=@var{symbolname}
1225 Do not copy symbol @var{symbolname} from the source file. This option
1226 may be given more than once.
1227
1228 @item --strip-unneeded-symbol=@var{symbolname}
1229 Do not copy symbol @var{symbolname} from the source file unless it is needed
1230 by a relocation. This option may be given more than once.
1231
1232 @item -G @var{symbolname}
1233 @itemx --keep-global-symbol=@var{symbolname}
1234 Keep only symbol @var{symbolname} global. Make all other symbols local
1235 to the file, so that they are not visible externally. This option may
1236 be given more than once.
1237
1238 @item --localize-hidden
1239 In an ELF object, mark all symbols that have hidden or internal visibility
1240 as local. This option applies on top of symbol-specific localization options
1241 such as @option{-L}.
1242
1243 @item -L @var{symbolname}
1244 @itemx --localize-symbol=@var{symbolname}
1245 Make symbol @var{symbolname} local to the file, so that it is not
1246 visible externally. This option may be given more than once.
1247
1248 @item -W @var{symbolname}
1249 @itemx --weaken-symbol=@var{symbolname}
1250 Make symbol @var{symbolname} weak. This option may be given more than once.
1251
1252 @item --globalize-symbol=@var{symbolname}
1253 Give symbol @var{symbolname} global scoping so that it is visible
1254 outside of the file in which it is defined. This option may be given
1255 more than once.
1256
1257 @item -w
1258 @itemx --wildcard
1259 Permit regular expressions in @var{symbolname}s used in other command
1260 line options. The question mark (?), asterisk (*), backslash (\) and
1261 square brackets ([]) operators can be used anywhere in the symbol
1262 name. If the first character of the symbol name is the exclamation
1263 point (!) then the sense of the switch is reversed for that symbol.
1264 For example:
1265
1266 @smallexample
1267 -w -W !foo -W fo*
1268 @end smallexample
1269
1270 would cause objcopy to weaken all symbols that start with ``fo''
1271 except for the symbol ``foo''.
1272
1273 @item -x
1274 @itemx --discard-all
1275 Do not copy non-global symbols from the source file.
1276 @c FIXME any reason to prefer "non-global" to "local" here?
1277
1278 @item -X
1279 @itemx --discard-locals
1280 Do not copy compiler-generated local symbols.
1281 (These usually start with @samp{L} or @samp{.}.)
1282
1283 @item -b @var{byte}
1284 @itemx --byte=@var{byte}
1285 If interleaving has been enabled via the @option{--interleave} option
1286 then start the range of bytes to keep at the @var{byte}th byte.
1287 @var{byte} can be in the range from 0 to @var{breadth}-1, where
1288 @var{breadth} is the value given by the @option{--interleave} option.
1289
1290 @item -i [@var{breadth}]
1291 @itemx --interleave[=@var{breadth}]
1292 Only copy a range out of every @var{breadth} bytes. (Header data is
1293 not affected). Select which byte in the range begins the copy with
1294 the @option{--byte} option. Select the width of the range with the
1295 @option{--interleave-width} option.
1296
1297 This option is useful for creating files to program @sc{rom}. It is
1298 typically used with an @code{srec} output target. Note that
1299 @command{objcopy} will complain if you do not specify the
1300 @option{--byte} option as well.
1301
1302 The default interleave breadth is 4, so with @option{--byte} set to 0,
1303 @command{objcopy} would copy the first byte out of every four bytes
1304 from the input to the output.
1305
1306 @item --interleave-width=@var{width}
1307 When used with the @option{--interleave} option, copy @var{width}
1308 bytes at a time. The start of the range of bytes to be copied is set
1309 by the @option{--byte} option, and the extent of the range is set with
1310 the @option{--interleave} option.
1311
1312 The default value for this option is 1. The value of @var{width} plus
1313 the @var{byte} value set by the @option{--byte} option must not exceed
1314 the interleave breadth set by the @option{--interleave} option.
1315
1316 This option can be used to create images for two 16-bit flashes interleaved
1317 in a 32-bit bus by passing @option{-b 0 -i 4 --interleave-width=2}
1318 and @option{-b 2 -i 4 --interleave-width=2} to two @command{objcopy}
1319 commands. If the input was '12345678' then the outputs would be
1320 '1256' and '3478' respectively.
1321
1322 @item -p
1323 @itemx --preserve-dates
1324 Set the access and modification dates of the output file to be the same
1325 as those of the input file.
1326
1327 @item -D
1328 @itemx --enable-deterministic-archives
1329 Operate in @emph{deterministic} mode. When copying archive members
1330 and writing the archive index, use zero for UIDs, GIDs, timestamps,
1331 and use consistent file modes for all files.
1332
1333 @item --debugging
1334 Convert debugging information, if possible. This is not the default
1335 because only certain debugging formats are supported, and the
1336 conversion process can be time consuming.
1337
1338 @item --gap-fill @var{val}
1339 Fill gaps between sections with @var{val}. This operation applies to
1340 the @emph{load address} (LMA) of the sections. It is done by increasing
1341 the size of the section with the lower address, and filling in the extra
1342 space created with @var{val}.
1343
1344 @item --pad-to @var{address}
1345 Pad the output file up to the load address @var{address}. This is
1346 done by increasing the size of the last section. The extra space is
1347 filled in with the value specified by @option{--gap-fill} (default zero).
1348
1349 @item --set-start @var{val}
1350 Set the start address of the new file to @var{val}. Not all object file
1351 formats support setting the start address.
1352
1353 @item --change-start @var{incr}
1354 @itemx --adjust-start @var{incr}
1355 @cindex changing start address
1356 Change the start address by adding @var{incr}. Not all object file
1357 formats support setting the start address.
1358
1359 @item --change-addresses @var{incr}
1360 @itemx --adjust-vma @var{incr}
1361 @cindex changing object addresses
1362 Change the VMA and LMA addresses of all sections, as well as the start
1363 address, by adding @var{incr}. Some object file formats do not permit
1364 section addresses to be changed arbitrarily. Note that this does not
1365 relocate the sections; if the program expects sections to be loaded at a
1366 certain address, and this option is used to change the sections such
1367 that they are loaded at a different address, the program may fail.
1368
1369 @item --change-section-address @var{section}@{=,+,-@}@var{val}
1370 @itemx --adjust-section-vma @var{section}@{=,+,-@}@var{val}
1371 @cindex changing section address
1372 Set or change both the VMA address and the LMA address of the named
1373 @var{section}. If @samp{=} is used, the section address is set to
1374 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1375 section address. See the comments under @option{--change-addresses},
1376 above. If @var{section} does not exist in the input file, a warning will
1377 be issued, unless @option{--no-change-warnings} is used.
1378
1379 @item --change-section-lma @var{section}@{=,+,-@}@var{val}
1380 @cindex changing section LMA
1381 Set or change the LMA address of the named @var{section}. The LMA
1382 address is the address where the section will be loaded into memory at
1383 program load time. Normally this is the same as the VMA address, which
1384 is the address of the section at program run time, but on some systems,
1385 especially those where a program is held in ROM, the two can be
1386 different. If @samp{=} is used, the section address is set to
1387 @var{val}. Otherwise, @var{val} is added to or subtracted from the
1388 section address. See the comments under @option{--change-addresses},
1389 above. If @var{section} does not exist in the input file, a warning
1390 will be issued, unless @option{--no-change-warnings} is used.
1391
1392 @item --change-section-vma @var{section}@{=,+,-@}@var{val}
1393 @cindex changing section VMA
1394 Set or change the VMA address of the named @var{section}. The VMA
1395 address is the address where the section will be located once the
1396 program has started executing. Normally this is the same as the LMA
1397 address, which is the address where the section will be loaded into
1398 memory, but on some systems, especially those where a program is held in
1399 ROM, the two can be different. If @samp{=} is used, the section address
1400 is set to @var{val}. Otherwise, @var{val} is added to or subtracted
1401 from the section address. See the comments under
1402 @option{--change-addresses}, above. If @var{section} does not exist in
1403 the input file, a warning will be issued, unless
1404 @option{--no-change-warnings} is used.
1405
1406 @item --change-warnings
1407 @itemx --adjust-warnings
1408 If @option{--change-section-address} or @option{--change-section-lma} or
1409 @option{--change-section-vma} is used, and the named section does not
1410 exist, issue a warning. This is the default.
1411
1412 @item --no-change-warnings
1413 @itemx --no-adjust-warnings
1414 Do not issue a warning if @option{--change-section-address} or
1415 @option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
1416 if the named section does not exist.
1417
1418 @item --set-section-flags @var{section}=@var{flags}
1419 Set the flags for the named section. The @var{flags} argument is a
1420 comma separated string of flag names. The recognized names are
1421 @samp{alloc}, @samp{contents}, @samp{load}, @samp{noload},
1422 @samp{readonly}, @samp{code}, @samp{data}, @samp{rom}, @samp{share}, and
1423 @samp{debug}. You can set the @samp{contents} flag for a section which
1424 does not have contents, but it is not meaningful to clear the
1425 @samp{contents} flag of a section which does have contents--just remove
1426 the section instead. Not all flags are meaningful for all object file
1427 formats.
1428
1429 @item --add-section @var{sectionname}=@var{filename}
1430 Add a new section named @var{sectionname} while copying the file. The
1431 contents of the new section are taken from the file @var{filename}. The
1432 size of the section will be the size of the file. This option only
1433 works on file formats which can support sections with arbitrary names.
1434
1435 @item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
1436 Rename a section from @var{oldname} to @var{newname}, optionally
1437 changing the section's flags to @var{flags} in the process. This has
1438 the advantage over usng a linker script to perform the rename in that
1439 the output stays as an object file and does not become a linked
1440 executable.
1441
1442 This option is particularly helpful when the input format is binary,
1443 since this will always create a section called .data. If for example,
1444 you wanted instead to create a section called .rodata containing binary
1445 data you could use the following command line to achieve it:
1446
1447 @smallexample
1448 objcopy -I binary -O <output_format> -B <architecture> \
1449 --rename-section .data=.rodata,alloc,load,readonly,data,contents \
1450 <input_binary_file> <output_object_file>
1451 @end smallexample
1452
1453 @item --long-section-names @{enable,disable,keep@}
1454 Controls the handling of long section names when processing @code{COFF}
1455 and @code{PE-COFF} object formats. The default behaviour, @samp{keep},
1456 is to preserve long section names if any are present in the input file.
1457 The @samp{enable} and @samp{disable} options forcibly enable or disable
1458 the use of long section names in the output object; when @samp{disable}
1459 is in effect, any long section names in the input object will be truncated.
1460 The @samp{enable} option will only emit long section names if any are
1461 present in the inputs; this is mostly the same as @samp{keep}, but it
1462 is left undefined whether the @samp{enable} option might force the
1463 creation of an empty string table in the output file.
1464
1465 @item --change-leading-char
1466 Some object file formats use special characters at the start of
1467 symbols. The most common such character is underscore, which compilers
1468 often add before every symbol. This option tells @command{objcopy} to
1469 change the leading character of every symbol when it converts between
1470 object file formats. If the object file formats use the same leading
1471 character, this option has no effect. Otherwise, it will add a
1472 character, or remove a character, or change a character, as
1473 appropriate.
1474
1475 @item --remove-leading-char
1476 If the first character of a global symbol is a special symbol leading
1477 character used by the object file format, remove the character. The
1478 most common symbol leading character is underscore. This option will
1479 remove a leading underscore from all global symbols. This can be useful
1480 if you want to link together objects of different file formats with
1481 different conventions for symbol names. This is different from
1482 @option{--change-leading-char} because it always changes the symbol name
1483 when appropriate, regardless of the object file format of the output
1484 file.
1485
1486 @item --reverse-bytes=@var{num}
1487 Reverse the bytes in a section with output contents. A section length must
1488 be evenly divisible by the value given in order for the swap to be able to
1489 take place. Reversing takes place before the interleaving is performed.
1490
1491 This option is used typically in generating ROM images for problematic
1492 target systems. For example, on some target boards, the 32-bit words
1493 fetched from 8-bit ROMs are re-assembled in little-endian byte order
1494 regardless of the CPU byte order. Depending on the programming model, the
1495 endianness of the ROM may need to be modified.
1496
1497 Consider a simple file with a section containing the following eight
1498 bytes: @code{12345678}.
1499
1500 Using @samp{--reverse-bytes=2} for the above example, the bytes in the
1501 output file would be ordered @code{21436587}.
1502
1503 Using @samp{--reverse-bytes=4} for the above example, the bytes in the
1504 output file would be ordered @code{43218765}.
1505
1506 By using @samp{--reverse-bytes=2} for the above example, followed by
1507 @samp{--reverse-bytes=4} on the output file, the bytes in the second
1508 output file would be ordered @code{34127856}.
1509
1510 @item --srec-len=@var{ival}
1511 Meaningful only for srec output. Set the maximum length of the Srecords
1512 being produced to @var{ival}. This length covers both address, data and
1513 crc fields.
1514
1515 @item --srec-forceS3
1516 Meaningful only for srec output. Avoid generation of S1/S2 records,
1517 creating S3-only record format.
1518
1519 @item --redefine-sym @var{old}=@var{new}
1520 Change the name of a symbol @var{old}, to @var{new}. This can be useful
1521 when one is trying link two things together for which you have no
1522 source, and there are name collisions.
1523
1524 @item --redefine-syms=@var{filename}
1525 Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
1526 listed in the file @var{filename}. @var{filename} is simply a flat file,
1527 with one symbol pair per line. Line comments may be introduced by the hash
1528 character. This option may be given more than once.
1529
1530 @item --weaken
1531 Change all global symbols in the file to be weak. This can be useful
1532 when building an object which will be linked against other objects using
1533 the @option{-R} option to the linker. This option is only effective when
1534 using an object file format which supports weak symbols.
1535
1536 @item --keep-symbols=@var{filename}
1537 Apply @option{--keep-symbol} option to each symbol listed in the file
1538 @var{filename}. @var{filename} is simply a flat file, with one symbol
1539 name per line. Line comments may be introduced by the hash character.
1540 This option may be given more than once.
1541
1542 @item --strip-symbols=@var{filename}
1543 Apply @option{--strip-symbol} option to each symbol listed in the file
1544 @var{filename}. @var{filename} is simply a flat file, with one symbol
1545 name per line. Line comments may be introduced by the hash character.
1546 This option may be given more than once.
1547
1548 @item --strip-unneeded-symbols=@var{filename}
1549 Apply @option{--strip-unneeded-symbol} option to each symbol listed in
1550 the file @var{filename}. @var{filename} is simply a flat file, with one
1551 symbol name per line. Line comments may be introduced by the hash
1552 character. This option may be given more than once.
1553
1554 @item --keep-global-symbols=@var{filename}
1555 Apply @option{--keep-global-symbol} option to each symbol listed in the
1556 file @var{filename}. @var{filename} is simply a flat file, with one
1557 symbol name per line. Line comments may be introduced by the hash
1558 character. This option may be given more than once.
1559
1560 @item --localize-symbols=@var{filename}
1561 Apply @option{--localize-symbol} option to each symbol listed in the file
1562 @var{filename}. @var{filename} is simply a flat file, with one symbol
1563 name per line. Line comments may be introduced by the hash character.
1564 This option may be given more than once.
1565
1566 @item --globalize-symbols=@var{filename}
1567 Apply @option{--globalize-symbol} option to each symbol listed in the file
1568 @var{filename}. @var{filename} is simply a flat file, with one symbol
1569 name per line. Line comments may be introduced by the hash character.
1570 This option may be given more than once.
1571
1572 @item --weaken-symbols=@var{filename}
1573 Apply @option{--weaken-symbol} option to each symbol listed in the file
1574 @var{filename}. @var{filename} is simply a flat file, with one symbol
1575 name per line. Line comments may be introduced by the hash character.
1576 This option may be given more than once.
1577
1578 @item --alt-machine-code=@var{index}
1579 If the output architecture has alternate machine codes, use the
1580 @var{index}th code instead of the default one. This is useful in case
1581 a machine is assigned an official code and the tool-chain adopts the
1582 new code, but other applications still depend on the original code
1583 being used. For ELF based architectures if the @var{index}
1584 alternative does not exist then the value is treated as an absolute
1585 number to be stored in the e_machine field of the ELF header.
1586
1587 @item --writable-text
1588 Mark the output text as writable. This option isn't meaningful for all
1589 object file formats.
1590
1591 @item --readonly-text
1592 Make the output text write protected. This option isn't meaningful for all
1593 object file formats.
1594
1595 @item --pure
1596 Mark the output file as demand paged. This option isn't meaningful for all
1597 object file formats.
1598
1599 @item --impure
1600 Mark the output file as impure. This option isn't meaningful for all
1601 object file formats.
1602
1603 @item --prefix-symbols=@var{string}
1604 Prefix all symbols in the output file with @var{string}.
1605
1606 @item --prefix-sections=@var{string}
1607 Prefix all section names in the output file with @var{string}.
1608
1609 @item --prefix-alloc-sections=@var{string}
1610 Prefix all the names of all allocated sections in the output file with
1611 @var{string}.
1612
1613 @item --add-gnu-debuglink=@var{path-to-file}
1614 Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
1615 and adds it to the output file.
1616
1617 @item --keep-file-symbols
1618 When stripping a file, perhaps with @option{--strip-debug} or
1619 @option{--strip-unneeded}, retain any symbols specifying source file names,
1620 which would otherwise get stripped.
1621
1622 @item --only-keep-debug
1623 Strip a file, removing contents of any sections that would not be
1624 stripped by @option{--strip-debug} and leaving the debugging sections
1625 intact. In ELF files, this preserves all note sections in the output.
1626
1627 The intention is that this option will be used in conjunction with
1628 @option{--add-gnu-debuglink} to create a two part executable. One a
1629 stripped binary which will occupy less space in RAM and in a
1630 distribution and the second a debugging information file which is only
1631 needed if debugging abilities are required. The suggested procedure
1632 to create these files is as follows:
1633
1634 @enumerate
1635 @item Link the executable as normal. Assuming that is is called
1636 @code{foo} then...
1637 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
1638 create a file containing the debugging info.
1639 @item Run @code{objcopy --strip-debug foo} to create a
1640 stripped executable.
1641 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
1642 to add a link to the debugging info into the stripped executable.
1643 @end enumerate
1644
1645 Note---the choice of @code{.dbg} as an extension for the debug info
1646 file is arbitrary. Also the @code{--only-keep-debug} step is
1647 optional. You could instead do this:
1648
1649 @enumerate
1650 @item Link the executable as normal.
1651 @item Copy @code{foo} to @code{foo.full}
1652 @item Run @code{objcopy --strip-debug foo}
1653 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
1654 @end enumerate
1655
1656 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
1657 full executable. It does not have to be a file created by the
1658 @option{--only-keep-debug} switch.
1659
1660 Note---this switch is only intended for use on fully linked files. It
1661 does not make sense to use it on object files where the debugging
1662 information may be incomplete. Besides the gnu_debuglink feature
1663 currently only supports the presence of one filename containing
1664 debugging information, not multiple filenames on a one-per-object-file
1665 basis.
1666
1667 @item --file-alignment @var{num}
1668 Specify the file alignment. Sections in the file will always begin at
1669 file offsets which are multiples of this number. This defaults to
1670 512.
1671 [This option is specific to PE targets.]
1672
1673 @item --heap @var{reserve}
1674 @itemx --heap @var{reserve},@var{commit}
1675 Specify the number of bytes of memory to reserve (and optionally commit)
1676 to be used as heap for this program.
1677 [This option is specific to PE targets.]
1678
1679 @item --image-base @var{value}
1680 Use @var{value} as the base address of your program or dll. This is
1681 the lowest memory location that will be used when your program or dll
1682 is loaded. To reduce the need to relocate and improve performance of
1683 your dlls, each should have a unique base address and not overlap any
1684 other dlls. The default is 0x400000 for executables, and 0x10000000
1685 for dlls.
1686 [This option is specific to PE targets.]
1687
1688 @item --section-alignment @var{num}
1689 Sets the section alignment. Sections in memory will always begin at
1690 addresses which are a multiple of this number. Defaults to 0x1000.
1691 [This option is specific to PE targets.]
1692
1693 @item --stack @var{reserve}
1694 @itemx --stack @var{reserve},@var{commit}
1695 Specify the number of bytes of memory to reserve (and optionally commit)
1696 to be used as stack for this program.
1697 [This option is specific to PE targets.]
1698
1699 @item --subsystem @var{which}
1700 @itemx --subsystem @var{which}:@var{major}
1701 @itemx --subsystem @var{which}:@var{major}.@var{minor}
1702 Specifies the subsystem under which your program will execute. The
1703 legal values for @var{which} are @code{native}, @code{windows},
1704 @code{console}, @code{posix}, @code{efi-app}, @code{efi-bsd},
1705 @code{efi-rtd}, @code{sal-rtd}, and @code{xbox}. You may optionally set
1706 the subsystem version also. Numeric values are also accepted for
1707 @var{which}.
1708 [This option is specific to PE targets.]
1709
1710 @item --extract-symbol
1711 Keep the file's section flags and symbols but remove all section data.
1712 Specifically, the option:
1713
1714 @itemize
1715 @item removes the contents of all sections;
1716 @item sets the size of every section to zero; and
1717 @item sets the file's start address to zero.
1718 @end itemize
1719
1720 This option is used to build a @file{.sym} file for a VxWorks kernel.
1721 It can also be a useful way of reducing the size of a @option{--just-symbols}
1722 linker input file.
1723
1724 @item --compress-debug-sections
1725 Compress DWARF debug sections using zlib.
1726
1727 @item --decompress-debug-sections
1728 Decompress DWARF debug sections using zlib.
1729
1730 @item -V
1731 @itemx --version
1732 Show the version number of @command{objcopy}.
1733
1734 @item -v
1735 @itemx --verbose
1736 Verbose output: list all object files modified. In the case of
1737 archives, @samp{objcopy -V} lists all members of the archive.
1738
1739 @item --help
1740 Show a summary of the options to @command{objcopy}.
1741
1742 @item --info
1743 Display a list showing all architectures and object formats available.
1744 @end table
1745
1746 @c man end
1747
1748 @ignore
1749 @c man begin SEEALSO objcopy
1750 ld(1), objdump(1), and the Info entries for @file{binutils}.
1751 @c man end
1752 @end ignore
1753
1754 @node objdump
1755 @chapter objdump
1756
1757 @cindex object file information
1758 @kindex objdump
1759
1760 @c man title objdump display information from object files.
1761
1762 @smallexample
1763 @c man begin SYNOPSIS objdump
1764 objdump [@option{-a}|@option{--archive-headers}]
1765 [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
1766 [@option{-C}|@option{--demangle}[=@var{style}] ]
1767 [@option{-d}|@option{--disassemble}]
1768 [@option{-D}|@option{--disassemble-all}]
1769 [@option{-z}|@option{--disassemble-zeroes}]
1770 [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
1771 [@option{-f}|@option{--file-headers}]
1772 [@option{-F}|@option{--file-offsets}]
1773 [@option{--file-start-context}]
1774 [@option{-g}|@option{--debugging}]
1775 [@option{-e}|@option{--debugging-tags}]
1776 [@option{-h}|@option{--section-headers}|@option{--headers}]
1777 [@option{-i}|@option{--info}]
1778 [@option{-j} @var{section}|@option{--section=}@var{section}]
1779 [@option{-l}|@option{--line-numbers}]
1780 [@option{-S}|@option{--source}]
1781 [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
1782 [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
1783 [@option{-p}|@option{--private-headers}]
1784 [@option{-P} @var{options}|@option{--private=}@var{options}]
1785 [@option{-r}|@option{--reloc}]
1786 [@option{-R}|@option{--dynamic-reloc}]
1787 [@option{-s}|@option{--full-contents}]
1788 [@option{-W[lLiaprmfFsoRt]}|
1789 @option{--dwarf}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
1790 [@option{-G}|@option{--stabs}]
1791 [@option{-t}|@option{--syms}]
1792 [@option{-T}|@option{--dynamic-syms}]
1793 [@option{-x}|@option{--all-headers}]
1794 [@option{-w}|@option{--wide}]
1795 [@option{--start-address=}@var{address}]
1796 [@option{--stop-address=}@var{address}]
1797 [@option{--prefix-addresses}]
1798 [@option{--[no-]show-raw-insn}]
1799 [@option{--adjust-vma=}@var{offset}]
1800 [@option{--special-syms}]
1801 [@option{--prefix=}@var{prefix}]
1802 [@option{--prefix-strip=}@var{level}]
1803 [@option{--insn-width=}@var{width}]
1804 [@option{-V}|@option{--version}]
1805 [@option{-H}|@option{--help}]
1806 @var{objfile}@dots{}
1807 @c man end
1808 @end smallexample
1809
1810 @c man begin DESCRIPTION objdump
1811
1812 @command{objdump} displays information about one or more object files.
1813 The options control what particular information to display. This
1814 information is mostly useful to programmers who are working on the
1815 compilation tools, as opposed to programmers who just want their
1816 program to compile and work.
1817
1818 @var{objfile}@dots{} are the object files to be examined. When you
1819 specify archives, @command{objdump} shows information on each of the member
1820 object files.
1821
1822 @c man end
1823
1824 @c man begin OPTIONS objdump
1825
1826 The long and short forms of options, shown here as alternatives, are
1827 equivalent. At least one option from the list
1828 @option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-P,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
1829
1830 @table @env
1831 @item -a
1832 @itemx --archive-header
1833 @cindex archive headers
1834 If any of the @var{objfile} files are archives, display the archive
1835 header information (in a format similar to @samp{ls -l}). Besides the
1836 information you could list with @samp{ar tv}, @samp{objdump -a} shows
1837 the object file format of each archive member.
1838
1839 @item --adjust-vma=@var{offset}
1840 @cindex section addresses in objdump
1841 @cindex VMA in objdump
1842 When dumping information, first add @var{offset} to all the section
1843 addresses. This is useful if the section addresses do not correspond to
1844 the symbol table, which can happen when putting sections at particular
1845 addresses when using a format which can not represent section addresses,
1846 such as a.out.
1847
1848 @item -b @var{bfdname}
1849 @itemx --target=@var{bfdname}
1850 @cindex object code format
1851 Specify that the object-code format for the object files is
1852 @var{bfdname}. This option may not be necessary; @var{objdump} can
1853 automatically recognize many formats.
1854
1855 For example,
1856 @example
1857 objdump -b oasys -m vax -h fu.o
1858 @end example
1859 @noindent
1860 displays summary information from the section headers (@option{-h}) of
1861 @file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
1862 file in the format produced by Oasys compilers. You can list the
1863 formats available with the @option{-i} option.
1864 @xref{Target Selection}, for more information.
1865
1866 @item -C
1867 @itemx --demangle[=@var{style}]
1868 @cindex demangling in objdump
1869 Decode (@dfn{demangle}) low-level symbol names into user-level names.
1870 Besides removing any initial underscore prepended by the system, this
1871 makes C++ function names readable. Different compilers have different
1872 mangling styles. The optional demangling style argument can be used to
1873 choose an appropriate demangling style for your compiler. @xref{c++filt},
1874 for more information on demangling.
1875
1876 @item -g
1877 @itemx --debugging
1878 Display debugging information. This attempts to parse STABS and IEEE
1879 debugging format information stored in the file and print it out using
1880 a C like syntax. If neither of these formats are found this option
1881 falls back on the @option{-W} option to print any DWARF information in
1882 the file.
1883
1884 @item -e
1885 @itemx --debugging-tags
1886 Like @option{-g}, but the information is generated in a format compatible
1887 with ctags tool.
1888
1889 @item -d
1890 @itemx --disassemble
1891 @cindex disassembling object code
1892 @cindex machine instructions
1893 Display the assembler mnemonics for the machine instructions from
1894 @var{objfile}. This option only disassembles those sections which are
1895 expected to contain instructions.
1896
1897 @item -D
1898 @itemx --disassemble-all
1899 Like @option{-d}, but disassemble the contents of all sections, not just
1900 those expected to contain instructions.
1901
1902 If the target is an ARM architecture this switch also has the effect
1903 of forcing the disassembler to decode pieces of data found in code
1904 sections as if they were instructions.
1905
1906 @item --prefix-addresses
1907 When disassembling, print the complete address on each line. This is
1908 the older disassembly format.
1909
1910 @item -EB
1911 @itemx -EL
1912 @itemx --endian=@{big|little@}
1913 @cindex endianness
1914 @cindex disassembly endianness
1915 Specify the endianness of the object files. This only affects
1916 disassembly. This can be useful when disassembling a file format which
1917 does not describe endianness information, such as S-records.
1918
1919 @item -f
1920 @itemx --file-headers
1921 @cindex object file header
1922 Display summary information from the overall header of
1923 each of the @var{objfile} files.
1924
1925 @item -F
1926 @itemx --file-offsets
1927 @cindex object file offsets
1928 When disassembling sections, whenever a symbol is displayed, also
1929 display the file offset of the region of data that is about to be
1930 dumped. If zeroes are being skipped, then when disassembly resumes,
1931 tell the user how many zeroes were skipped and the file offset of the
1932 location from where the disassembly resumes. When dumping sections,
1933 display the file offset of the location from where the dump starts.
1934
1935 @item --file-start-context
1936 @cindex source code context
1937 Specify that when displaying interlisted source code/disassembly
1938 (assumes @option{-S}) from a file that has not yet been displayed, extend the
1939 context to the start of the file.
1940
1941 @item -h
1942 @itemx --section-headers
1943 @itemx --headers
1944 @cindex section headers
1945 Display summary information from the section headers of the
1946 object file.
1947
1948 File segments may be relocated to nonstandard addresses, for example by
1949 using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
1950 @command{ld}. However, some object file formats, such as a.out, do not
1951 store the starting address of the file segments. In those situations,
1952 although @command{ld} relocates the sections correctly, using @samp{objdump
1953 -h} to list the file section headers cannot show the correct addresses.
1954 Instead, it shows the usual addresses, which are implicit for the
1955 target.
1956
1957 @item -H
1958 @itemx --help
1959 Print a summary of the options to @command{objdump} and exit.
1960
1961 @item -i
1962 @itemx --info
1963 @cindex architectures available
1964 @cindex object formats available
1965 Display a list showing all architectures and object formats available
1966 for specification with @option{-b} or @option{-m}.
1967
1968 @item -j @var{name}
1969 @itemx --section=@var{name}
1970 @cindex section information
1971 Display information only for section @var{name}.
1972
1973 @item -l
1974 @itemx --line-numbers
1975 @cindex source filenames for object files
1976 Label the display (using debugging information) with the filename and
1977 source line numbers corresponding to the object code or relocs shown.
1978 Only useful with @option{-d}, @option{-D}, or @option{-r}.
1979
1980 @item -m @var{machine}
1981 @itemx --architecture=@var{machine}
1982 @cindex architecture
1983 @cindex disassembly architecture
1984 Specify the architecture to use when disassembling object files. This
1985 can be useful when disassembling object files which do not describe
1986 architecture information, such as S-records. You can list the available
1987 architectures with the @option{-i} option.
1988
1989 If the target is an ARM architecture then this switch has an
1990 additional effect. It restricts the disassembly to only those
1991 instructions supported by the architecture specified by @var{machine}.
1992 If it is necessary to use this switch because the input file does not
1993 contain any architecture information, but it is also desired to
1994 disassemble all the instructions use @option{-marm}.
1995
1996 @item -M @var{options}
1997 @itemx --disassembler-options=@var{options}
1998 Pass target specific information to the disassembler. Only supported on
1999 some targets. If it is necessary to specify more than one
2000 disassembler option then multiple @option{-M} options can be used or
2001 can be placed together into a comma separated list.
2002
2003 If the target is an ARM architecture then this switch can be used to
2004 select which register name set is used during disassembler. Specifying
2005 @option{-M reg-names-std} (the default) will select the register names as
2006 used in ARM's instruction set documentation, but with register 13 called
2007 'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
2008 @option{-M reg-names-apcs} will select the name set used by the ARM
2009 Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
2010 just use @samp{r} followed by the register number.
2011
2012 There are also two variants on the APCS register naming scheme enabled
2013 by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
2014 use the ARM/Thumb Procedure Call Standard naming conventions. (Either
2015 with the normal register names or the special register names).
2016
2017 This option can also be used for ARM architectures to force the
2018 disassembler to interpret all instructions as Thumb instructions by
2019 using the switch @option{--disassembler-options=force-thumb}. This can be
2020 useful when attempting to disassemble thumb code produced by other
2021 compilers.
2022
2023 For the x86, some of the options duplicate functions of the @option{-m}
2024 switch, but allow finer grained control. Multiple selections from the
2025 following may be specified as a comma separated string.
2026 @option{x86-64}, @option{i386} and @option{i8086} select disassembly for
2027 the given architecture. @option{intel} and @option{att} select between
2028 intel syntax mode and AT&T syntax mode.
2029 @option{intel-mnemonic} and @option{att-mnemonic} select between
2030 intel mnemonic mode and AT&T mnemonic mode. @option{intel-mnemonic}
2031 implies @option{intel} and @option{att-mnemonic} implies @option{att}.
2032 @option{addr64}, @option{addr32},
2033 @option{addr16}, @option{data32} and @option{data16} specify the default
2034 address size and operand size. These four options will be overridden if
2035 @option{x86-64}, @option{i386} or @option{i8086} appear later in the
2036 option string. Lastly, @option{suffix}, when in AT&T mode,
2037 instructs the disassembler to print a mnemonic suffix even when the
2038 suffix could be inferred by the operands.
2039
2040 For PowerPC, @option{booke} controls the disassembly of BookE
2041 instructions. @option{32} and @option{64} select PowerPC and
2042 PowerPC64 disassembly, respectively. @option{e300} selects
2043 disassembly for the e300 family. @option{440} selects disassembly for
2044 the PowerPC 440. @option{ppcps} selects disassembly for the paired
2045 single instructions of the PPC750CL.
2046
2047 For MIPS, this option controls the printing of instruction mnemonic
2048 names and register names in disassembled instructions. Multiple
2049 selections from the following may be specified as a comma separated
2050 string, and invalid options are ignored:
2051
2052 @table @code
2053 @item no-aliases
2054 Print the 'raw' instruction mnemonic instead of some pseudo
2055 instruction mnemonic. I.e., print 'daddu' or 'or' instead of 'move',
2056 'sll' instead of 'nop', etc.
2057
2058 @item gpr-names=@var{ABI}
2059 Print GPR (general-purpose register) names as appropriate
2060 for the specified ABI. By default, GPR names are selected according to
2061 the ABI of the binary being disassembled.
2062
2063 @item fpr-names=@var{ABI}
2064 Print FPR (floating-point register) names as
2065 appropriate for the specified ABI. By default, FPR numbers are printed
2066 rather than names.
2067
2068 @item cp0-names=@var{ARCH}
2069 Print CP0 (system control coprocessor; coprocessor 0) register names
2070 as appropriate for the CPU or architecture specified by
2071 @var{ARCH}. By default, CP0 register names are selected according to
2072 the architecture and CPU of the binary being disassembled.
2073
2074 @item hwr-names=@var{ARCH}
2075 Print HWR (hardware register, used by the @code{rdhwr} instruction) names
2076 as appropriate for the CPU or architecture specified by
2077 @var{ARCH}. By default, HWR names are selected according to
2078 the architecture and CPU of the binary being disassembled.
2079
2080 @item reg-names=@var{ABI}
2081 Print GPR and FPR names as appropriate for the selected ABI.
2082
2083 @item reg-names=@var{ARCH}
2084 Print CPU-specific register names (CP0 register and HWR names)
2085 as appropriate for the selected CPU or architecture.
2086 @end table
2087
2088 For any of the options listed above, @var{ABI} or
2089 @var{ARCH} may be specified as @samp{numeric} to have numbers printed
2090 rather than names, for the selected types of registers.
2091 You can list the available values of @var{ABI} and @var{ARCH} using
2092 the @option{--help} option.
2093
2094 For VAX, you can specify function entry addresses with @option{-M
2095 entry:0xf00ba}. You can use this multiple times to properly
2096 disassemble VAX binary files that don't contain symbol tables (like
2097 ROM dumps). In these cases, the function entry mask would otherwise
2098 be decoded as VAX instructions, which would probably lead the rest
2099 of the function being wrongly disassembled.
2100
2101 @item -p
2102 @itemx --private-headers
2103 Print information that is specific to the object file format. The exact
2104 information printed depends upon the object file format. For some
2105 object file formats, no additional information is printed.
2106
2107 @item -P @var{options}
2108 @itemx --private=@var{options}
2109 Print information that is specific to the object file format. The
2110 argument @var{options} is a comma separated list that depends on the
2111 format (the lists of options is displayed with the help).
2112
2113 For XCOFF, the available options are: @option{header}, @option{aout},
2114 @option{sections}, @option{syms}, @option{relocs}, @option{lineno},
2115 @option{loader}, @option{except}, @option{typchk}, @option{traceback}
2116 and @option{toc}.
2117
2118 @item -r
2119 @itemx --reloc
2120 @cindex relocation entries, in object file
2121 Print the relocation entries of the file. If used with @option{-d} or
2122 @option{-D}, the relocations are printed interspersed with the
2123 disassembly.
2124
2125 @item -R
2126 @itemx --dynamic-reloc
2127 @cindex dynamic relocation entries, in object file
2128 Print the dynamic relocation entries of the file. This is only
2129 meaningful for dynamic objects, such as certain types of shared
2130 libraries. As for @option{-r}, if used with @option{-d} or
2131 @option{-D}, the relocations are printed interspersed with the
2132 disassembly.
2133
2134 @item -s
2135 @itemx --full-contents
2136 @cindex sections, full contents
2137 @cindex object file sections
2138 Display the full contents of any sections requested. By default all
2139 non-empty sections are displayed.
2140
2141 @item -S
2142 @itemx --source
2143 @cindex source disassembly
2144 @cindex disassembly, with source
2145 Display source code intermixed with disassembly, if possible. Implies
2146 @option{-d}.
2147
2148 @item --prefix=@var{prefix}
2149 @cindex Add prefix to absolute paths
2150 Specify @var{prefix} to add to the absolute paths when used with
2151 @option{-S}.
2152
2153 @item --prefix-strip=@var{level}
2154 @cindex Strip absolute paths
2155 Indicate how many initial directory names to strip off the hardwired
2156 absolute paths. It has no effect without @option{--prefix=}@var{prefix}.
2157
2158 @item --show-raw-insn
2159 When disassembling instructions, print the instruction in hex as well as
2160 in symbolic form. This is the default except when
2161 @option{--prefix-addresses} is used.
2162
2163 @item --no-show-raw-insn
2164 When disassembling instructions, do not print the instruction bytes.
2165 This is the default when @option{--prefix-addresses} is used.
2166
2167 @item --insn-width=@var{width}
2168 @cindex Instruction width
2169 Display @var{width} bytes on a single line when disassembling
2170 instructions.
2171
2172 @item -W[lLiaprmfFsoRt]
2173 @itemx --dwarf[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
2174 @cindex DWARF
2175 @cindex debug symbols
2176 Displays the contents of the debug sections in the file, if any are
2177 present. If one of the optional letters or words follows the switch
2178 then only data found in those specific sections will be dumped.
2179
2180 Note that there is no single letter option to display the content of
2181 trace sections or .gdb_index.
2182
2183 Note: the output from the @option{=info} option can also be affected
2184 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
2185
2186 @item --dwarf-depth=@var{n}
2187 Limit the dump of the @code{.debug_info} section to @var{n} children.
2188 This is only useful with @option{--dwarf=info}. The default is
2189 to print all DIEs; the special value 0 for @var{n} will also have this
2190 effect.
2191
2192 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
2193 levels will not be printed. The range for @var{n} is zero-based.
2194
2195 @item --dwarf-start=@var{n}
2196 Print only DIEs beginning with the DIE numbered @var{n}. This is only
2197 useful with @option{--dwarf=info}.
2198
2199 If specified, this option will suppress printing of any header
2200 information and all DIEs before the DIE numbered @var{n}. Only
2201 siblings and children of the specified DIE will be printed.
2202
2203 This can be used in conjunction with @option{--dwarf-depth}.
2204
2205 @item -G
2206 @itemx --stabs
2207 @cindex stab
2208 @cindex .stab
2209 @cindex debug symbols
2210 @cindex ELF object file format
2211 Display the full contents of any sections requested. Display the
2212 contents of the .stab and .stab.index and .stab.excl sections from an
2213 ELF file. This is only useful on systems (such as Solaris 2.0) in which
2214 @code{.stab} debugging symbol-table entries are carried in an ELF
2215 section. In most other file formats, debugging symbol-table entries are
2216 interleaved with linkage symbols, and are visible in the @option{--syms}
2217 output.
2218 @ifclear man
2219 For more information on stabs symbols, see @ref{Top,Stabs,Stabs
2220 Overview,stabs.info, The ``stabs'' debug format}.
2221 @end ifclear
2222
2223 @item --start-address=@var{address}
2224 @cindex start-address
2225 Start displaying data at the specified address. This affects the output
2226 of the @option{-d}, @option{-r} and @option{-s} options.
2227
2228 @item --stop-address=@var{address}
2229 @cindex stop-address
2230 Stop displaying data at the specified address. This affects the output
2231 of the @option{-d}, @option{-r} and @option{-s} options.
2232
2233 @item -t
2234 @itemx --syms
2235 @cindex symbol table entries, printing
2236 Print the symbol table entries of the file.
2237 This is similar to the information provided by the @samp{nm} program,
2238 although the display format is different. The format of the output
2239 depends upon the format of the file being dumped, but there are two main
2240 types. One looks like this:
2241
2242 @smallexample
2243 [ 4](sec 3)(fl 0x00)(ty 0)(scl 3) (nx 1) 0x00000000 .bss
2244 [ 6](sec 1)(fl 0x00)(ty 0)(scl 2) (nx 0) 0x00000000 fred
2245 @end smallexample
2246
2247 where the number inside the square brackets is the number of the entry
2248 in the symbol table, the @var{sec} number is the section number, the
2249 @var{fl} value are the symbol's flag bits, the @var{ty} number is the
2250 symbol's type, the @var{scl} number is the symbol's storage class and
2251 the @var{nx} value is the number of auxilary entries associated with
2252 the symbol. The last two fields are the symbol's value and its name.
2253
2254 The other common output format, usually seen with ELF based files,
2255 looks like this:
2256
2257 @smallexample
2258 00000000 l d .bss 00000000 .bss
2259 00000000 g .text 00000000 fred
2260 @end smallexample
2261
2262 Here the first number is the symbol's value (sometimes refered to as
2263 its address). The next field is actually a set of characters and
2264 spaces indicating the flag bits that are set on the symbol. These
2265 characters are described below. Next is the section with which the
2266 symbol is associated or @emph{*ABS*} if the section is absolute (ie
2267 not connected with any section), or @emph{*UND*} if the section is
2268 referenced in the file being dumped, but not defined there.
2269
2270 After the section name comes another field, a number, which for common
2271 symbols is the alignment and for other symbol is the size. Finally
2272 the symbol's name is displayed.
2273
2274 The flag characters are divided into 7 groups as follows:
2275 @table @code
2276 @item l
2277 @itemx g
2278 @itemx u
2279 @itemx !
2280 The symbol is a local (l), global (g), unique global (u), neither
2281 global nor local (a space) or both global and local (!). A
2282 symbol can be neither local or global for a variety of reasons, e.g.,
2283 because it is used for debugging, but it is probably an indication of
2284 a bug if it is ever both local and global. Unique global symbols are
2285 a GNU extension to the standard set of ELF symbol bindings. For such
2286 a symbol the dynamic linker will make sure that in the entire process
2287 there is just one symbol with this name and type in use.
2288
2289 @item w
2290 The symbol is weak (w) or strong (a space).
2291
2292 @item C
2293 The symbol denotes a constructor (C) or an ordinary symbol (a space).
2294
2295 @item W
2296 The symbol is a warning (W) or a normal symbol (a space). A warning
2297 symbol's name is a message to be displayed if the symbol following the
2298 warning symbol is ever referenced.
2299
2300 @item I
2301 @item i
2302 The symbol is an indirect reference to another symbol (I), a function
2303 to be evaluated during reloc processing (i) or a normal symbol (a
2304 space).
2305
2306 @item d
2307 @itemx D
2308 The symbol is a debugging symbol (d) or a dynamic symbol (D) or a
2309 normal symbol (a space).
2310
2311 @item F
2312 @item f
2313 @item O
2314 The symbol is the name of a function (F) or a file (f) or an object
2315 (O) or just a normal symbol (a space).
2316 @end table
2317
2318 @item -T
2319 @itemx --dynamic-syms
2320 @cindex dynamic symbol table entries, printing
2321 Print the dynamic symbol table entries of the file. This is only
2322 meaningful for dynamic objects, such as certain types of shared
2323 libraries. This is similar to the information provided by the @samp{nm}
2324 program when given the @option{-D} (@option{--dynamic}) option.
2325
2326 @item --special-syms
2327 When displaying symbols include those which the target considers to be
2328 special in some way and which would not normally be of interest to the
2329 user.
2330
2331 @item -V
2332 @itemx --version
2333 Print the version number of @command{objdump} and exit.
2334
2335 @item -x
2336 @itemx --all-headers
2337 @cindex all header information, object file
2338 @cindex header information, all
2339 Display all available header information, including the symbol table and
2340 relocation entries. Using @option{-x} is equivalent to specifying all of
2341 @option{-a -f -h -p -r -t}.
2342
2343 @item -w
2344 @itemx --wide
2345 @cindex wide output, printing
2346 Format some lines for output devices that have more than 80 columns.
2347 Also do not truncate symbol names when they are displayed.
2348
2349 @item -z
2350 @itemx --disassemble-zeroes
2351 Normally the disassembly output will skip blocks of zeroes. This
2352 option directs the disassembler to disassemble those blocks, just like
2353 any other data.
2354 @end table
2355
2356 @c man end
2357
2358 @ignore
2359 @c man begin SEEALSO objdump
2360 nm(1), readelf(1), and the Info entries for @file{binutils}.
2361 @c man end
2362 @end ignore
2363
2364 @node ranlib
2365 @chapter ranlib
2366
2367 @kindex ranlib
2368 @cindex archive contents
2369 @cindex symbol index
2370
2371 @c man title ranlib generate index to archive.
2372
2373 @smallexample
2374 @c man begin SYNOPSIS ranlib
2375 ranlib [@option{--plugin} @var{name}] [@option{-DhHvVt}] @var{archive}
2376 @c man end
2377 @end smallexample
2378
2379 @c man begin DESCRIPTION ranlib
2380
2381 @command{ranlib} generates an index to the contents of an archive and
2382 stores it in the archive. The index lists each symbol defined by a
2383 member of an archive that is a relocatable object file.
2384
2385 You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
2386
2387 An archive with such an index speeds up linking to the library and
2388 allows routines in the library to call each other without regard to
2389 their placement in the archive.
2390
2391 The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
2392 @command{ranlib} is completely equivalent to executing @samp{ar -s}.
2393 @xref{ar}.
2394
2395 @c man end
2396
2397 @c man begin OPTIONS ranlib
2398
2399 @table @env
2400 @item -h
2401 @itemx -H
2402 @itemx --help
2403 Show usage information for @command{ranlib}.
2404
2405 @item -v
2406 @itemx -V
2407 @itemx --version
2408 Show the version number of @command{ranlib}.
2409
2410 @item -D
2411 @cindex deterministic archives
2412 @kindex --enable-deterministic-archives
2413 Operate in @emph{deterministic} mode. The symbol map archive member's
2414 header will show zero for the UID, GID, and timestamp. When this
2415 option is used, multiple runs will produce identical output files.
2416
2417 This is the default unless @file{binutils} was configured with
2418 @option{--enable-deterministic-archives}.
2419
2420 @item -t
2421 Update the timestamp of the symbol map of an archive.
2422
2423 @item -U
2424 @cindex deterministic archives
2425 @kindex --enable-deterministic-archives
2426 Do @emph{not} operate in @emph{deterministic} mode. This is the
2427 inverse of the @samp{-D} option, above: the archive index will get
2428 actual UID, GID, timestamp, and file mode values.
2429
2430 This is the default unless @file{binutils} was configured with
2431 @option{--enable-deterministic-archives}.
2432 @end table
2433
2434 @c man end
2435
2436 @ignore
2437 @c man begin SEEALSO ranlib
2438 ar(1), nm(1), and the Info entries for @file{binutils}.
2439 @c man end
2440 @end ignore
2441
2442 @node size
2443 @chapter size
2444
2445 @kindex size
2446 @cindex section sizes
2447
2448 @c man title size list section sizes and total size.
2449
2450 @smallexample
2451 @c man begin SYNOPSIS size
2452 size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
2453 [@option{--help}]
2454 [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
2455 [@option{--common}]
2456 [@option{-t}|@option{--totals}]
2457 [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
2458 [@var{objfile}@dots{}]
2459 @c man end
2460 @end smallexample
2461
2462 @c man begin DESCRIPTION size
2463
2464 The @sc{gnu} @command{size} utility lists the section sizes---and the total
2465 size---for each of the object or archive files @var{objfile} in its
2466 argument list. By default, one line of output is generated for each
2467 object file or each module in an archive.
2468
2469 @var{objfile}@dots{} are the object files to be examined.
2470 If none are specified, the file @code{a.out} will be used.
2471
2472 @c man end
2473
2474 @c man begin OPTIONS size
2475
2476 The command line options have the following meanings:
2477
2478 @table @env
2479 @item -A
2480 @itemx -B
2481 @itemx --format=@var{compatibility}
2482 @cindex @command{size} display format
2483 Using one of these options, you can choose whether the output from @sc{gnu}
2484 @command{size} resembles output from System V @command{size} (using @option{-A},
2485 or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
2486 @option{--format=berkeley}). The default is the one-line format similar to
2487 Berkeley's.
2488 @c Bonus for doc-source readers: you can also say --format=strange (or
2489 @c anything else that starts with 's') for sysv, and --format=boring (or
2490 @c anything else that starts with 'b') for Berkeley.
2491
2492 Here is an example of the Berkeley (default) format of output from
2493 @command{size}:
2494 @smallexample
2495 $ size --format=Berkeley ranlib size
2496 text data bss dec hex filename
2497 294880 81920 11592 388392 5ed28 ranlib
2498 294880 81920 11888 388688 5ee50 size
2499 @end smallexample
2500
2501 @noindent
2502 This is the same data, but displayed closer to System V conventions:
2503
2504 @smallexample
2505 $ size --format=SysV ranlib size
2506 ranlib :
2507 section size addr
2508 .text 294880 8192
2509 .data 81920 303104
2510 .bss 11592 385024
2511 Total 388392
2512
2513
2514 size :
2515 section size addr
2516 .text 294880 8192
2517 .data 81920 303104
2518 .bss 11888 385024
2519 Total 388688
2520 @end smallexample
2521
2522 @item --help
2523 Show a summary of acceptable arguments and options.
2524
2525 @item -d
2526 @itemx -o
2527 @itemx -x
2528 @itemx --radix=@var{number}
2529 @cindex @command{size} number format
2530 @cindex radix for section sizes
2531 Using one of these options, you can control whether the size of each
2532 section is given in decimal (@option{-d}, or @option{--radix=10}); octal
2533 (@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
2534 @option{--radix=16}). In @option{--radix=@var{number}}, only the three
2535 values (8, 10, 16) are supported. The total size is always given in two
2536 radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
2537 octal and hexadecimal if you're using @option{-o}.
2538
2539 @item --common
2540 Print total size of common symbols in each file. When using Berkeley
2541 format these are included in the bss size.
2542
2543 @item -t
2544 @itemx --totals
2545 Show totals of all objects listed (Berkeley format listing mode only).
2546
2547 @item --target=@var{bfdname}
2548 @cindex object code format
2549 Specify that the object-code format for @var{objfile} is
2550 @var{bfdname}. This option may not be necessary; @command{size} can
2551 automatically recognize many formats.
2552 @xref{Target Selection}, for more information.
2553
2554 @item -V
2555 @itemx --version
2556 Display the version number of @command{size}.
2557 @end table
2558
2559 @c man end
2560
2561 @ignore
2562 @c man begin SEEALSO size
2563 ar(1), objdump(1), readelf(1), and the Info entries for @file{binutils}.
2564 @c man end
2565 @end ignore
2566
2567 @node strings
2568 @chapter strings
2569 @kindex strings
2570 @cindex listings strings
2571 @cindex printing strings
2572 @cindex strings, printing
2573
2574 @c man title strings print the strings of printable characters in files.
2575
2576 @smallexample
2577 @c man begin SYNOPSIS strings
2578 strings [@option{-afovV}] [@option{-}@var{min-len}]
2579 [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
2580 [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
2581 [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
2582 [@option{-}] [@option{--all}] [@option{--print-file-name}]
2583 [@option{-T} @var{bfdname}] [@option{--target=}@var{bfdname}]
2584 [@option{--help}] [@option{--version}] @var{file}@dots{}
2585 @c man end
2586 @end smallexample
2587
2588 @c man begin DESCRIPTION strings
2589
2590 For each @var{file} given, @sc{gnu} @command{strings} prints the printable
2591 character sequences that are at least 4 characters long (or the number
2592 given with the options below) and are followed by an unprintable
2593 character. By default, it only prints the strings from the initialized
2594 and loaded sections of object files; for other types of files, it prints
2595 the strings from the whole file.
2596
2597 @command{strings} is mainly useful for determining the contents of non-text
2598 files.
2599
2600 @c man end
2601
2602 @c man begin OPTIONS strings
2603
2604 @table @env
2605 @item -a
2606 @itemx --all
2607 @itemx -
2608 Do not scan only the initialized and loaded sections of object files;
2609 scan the whole files.
2610
2611 @item -f
2612 @itemx --print-file-name
2613 Print the name of the file before each string.
2614
2615 @item --help
2616 Print a summary of the program usage on the standard output and exit.
2617
2618 @item -@var{min-len}
2619 @itemx -n @var{min-len}
2620 @itemx --bytes=@var{min-len}
2621 Print sequences of characters that are at least @var{min-len} characters
2622 long, instead of the default 4.
2623
2624 @item -o
2625 Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
2626 act like @samp{-t d} instead. Since we can not be compatible with both
2627 ways, we simply chose one.
2628
2629 @item -t @var{radix}
2630 @itemx --radix=@var{radix}
2631 Print the offset within the file before each string. The single
2632 character argument specifies the radix of the offset---@samp{o} for
2633 octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
2634
2635 @item -e @var{encoding}
2636 @itemx --encoding=@var{encoding}
2637 Select the character encoding of the strings that are to be found.
2638 Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
2639 characters (ASCII, ISO 8859, etc., default), @samp{S} =
2640 single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
2641 16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
2642 littleendian. Useful for finding wide character strings. (@samp{l}
2643 and @samp{b} apply to, for example, Unicode UTF-16/UCS-2 encodings).
2644
2645 @item -T @var{bfdname}
2646 @itemx --target=@var{bfdname}
2647 @cindex object code format
2648 Specify an object code format other than your system's default format.
2649 @xref{Target Selection}, for more information.
2650
2651 @item -v
2652 @itemx -V
2653 @itemx --version
2654 Print the program version number on the standard output and exit.
2655 @end table
2656
2657 @c man end
2658
2659 @ignore
2660 @c man begin SEEALSO strings
2661 ar(1), nm(1), objdump(1), ranlib(1), readelf(1)
2662 and the Info entries for @file{binutils}.
2663 @c man end
2664 @end ignore
2665
2666 @node strip
2667 @chapter strip
2668
2669 @kindex strip
2670 @cindex removing symbols
2671 @cindex discarding symbols
2672 @cindex symbols, discarding
2673
2674 @c man title strip Discard symbols from object files.
2675
2676 @smallexample
2677 @c man begin SYNOPSIS strip
2678 strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
2679 [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
2680 [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
2681 [@option{-s}|@option{--strip-all}]
2682 [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
2683 [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
2684 [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
2685 [@option{-w}|@option{--wildcard}]
2686 [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
2687 [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
2688 [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
2689 [@option{-D}|@option{--enable-deterministic-archives}]
2690 [@option{--keep-file-symbols}]
2691 [@option{--only-keep-debug}]
2692 [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
2693 [@option{--help}] [@option{--info}]
2694 @var{objfile}@dots{}
2695 @c man end
2696 @end smallexample
2697
2698 @c man begin DESCRIPTION strip
2699
2700 @sc{gnu} @command{strip} discards all symbols from object files
2701 @var{objfile}. The list of object files may include archives.
2702 At least one object file must be given.
2703
2704 @command{strip} modifies the files named in its argument,
2705 rather than writing modified copies under different names.
2706
2707 @c man end
2708
2709 @c man begin OPTIONS strip
2710
2711 @table @env
2712 @item -F @var{bfdname}
2713 @itemx --target=@var{bfdname}
2714 Treat the original @var{objfile} as a file with the object
2715 code format @var{bfdname}, and rewrite it in the same format.
2716 @xref{Target Selection}, for more information.
2717
2718 @item --help
2719 Show a summary of the options to @command{strip} and exit.
2720
2721 @item --info
2722 Display a list showing all architectures and object formats available.
2723
2724 @item -I @var{bfdname}
2725 @itemx --input-target=@var{bfdname}
2726 Treat the original @var{objfile} as a file with the object
2727 code format @var{bfdname}.
2728 @xref{Target Selection}, for more information.
2729
2730 @item -O @var{bfdname}
2731 @itemx --output-target=@var{bfdname}
2732 Replace @var{objfile} with a file in the output format @var{bfdname}.
2733 @xref{Target Selection}, for more information.
2734
2735 @item -R @var{sectionname}
2736 @itemx --remove-section=@var{sectionname}
2737 Remove any section named @var{sectionname} from the output file. This
2738 option may be given more than once. Note that using this option
2739 inappropriately may make the output file unusable.
2740
2741 @item -s
2742 @itemx --strip-all
2743 Remove all symbols.
2744
2745 @item -g
2746 @itemx -S
2747 @itemx -d
2748 @itemx --strip-debug
2749 Remove debugging symbols only.
2750
2751 @item --strip-unneeded
2752 Remove all symbols that are not needed for relocation processing.
2753
2754 @item -K @var{symbolname}
2755 @itemx --keep-symbol=@var{symbolname}
2756 When stripping symbols, keep symbol @var{symbolname} even if it would
2757 normally be stripped. This option may be given more than once.
2758
2759 @item -N @var{symbolname}
2760 @itemx --strip-symbol=@var{symbolname}
2761 Remove symbol @var{symbolname} from the source file. This option may be
2762 given more than once, and may be combined with strip options other than
2763 @option{-K}.
2764
2765 @item -o @var{file}
2766 Put the stripped output in @var{file}, rather than replacing the
2767 existing file. When this argument is used, only one @var{objfile}
2768 argument may be specified.
2769
2770 @item -p
2771 @itemx --preserve-dates
2772 Preserve the access and modification dates of the file.
2773
2774 @item -D
2775 @itemx --enable-deterministic-archives
2776 Operate in @emph{deterministic} mode. When copying archive members
2777 and writing the archive index, use zero for UIDs, GIDs, timestamps,
2778 and use consistent file modes for all files.
2779
2780 @item -w
2781 @itemx --wildcard
2782 Permit regular expressions in @var{symbolname}s used in other command
2783 line options. The question mark (?), asterisk (*), backslash (\) and
2784 square brackets ([]) operators can be used anywhere in the symbol
2785 name. If the first character of the symbol name is the exclamation
2786 point (!) then the sense of the switch is reversed for that symbol.
2787 For example:
2788
2789 @smallexample
2790 -w -K !foo -K fo*
2791 @end smallexample
2792
2793 would cause strip to only keep symbols that start with the letters
2794 ``fo'', but to discard the symbol ``foo''.
2795
2796 @item -x
2797 @itemx --discard-all
2798 Remove non-global symbols.
2799
2800 @item -X
2801 @itemx --discard-locals
2802 Remove compiler-generated local symbols.
2803 (These usually start with @samp{L} or @samp{.}.)
2804
2805 @item --keep-file-symbols
2806 When stripping a file, perhaps with @option{--strip-debug} or
2807 @option{--strip-unneeded}, retain any symbols specifying source file names,
2808 which would otherwise get stripped.
2809
2810 @item --only-keep-debug
2811 Strip a file, removing contents of any sections that would not be
2812 stripped by @option{--strip-debug} and leaving the debugging sections
2813 intact. In ELF files, this preserves all note sections in the output.
2814
2815 The intention is that this option will be used in conjunction with
2816 @option{--add-gnu-debuglink} to create a two part executable. One a
2817 stripped binary which will occupy less space in RAM and in a
2818 distribution and the second a debugging information file which is only
2819 needed if debugging abilities are required. The suggested procedure
2820 to create these files is as follows:
2821
2822 @enumerate
2823 @item Link the executable as normal. Assuming that is is called
2824 @code{foo} then...
2825 @item Run @code{objcopy --only-keep-debug foo foo.dbg} to
2826 create a file containing the debugging info.
2827 @item Run @code{objcopy --strip-debug foo} to create a
2828 stripped executable.
2829 @item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
2830 to add a link to the debugging info into the stripped executable.
2831 @end enumerate
2832
2833 Note---the choice of @code{.dbg} as an extension for the debug info
2834 file is arbitrary. Also the @code{--only-keep-debug} step is
2835 optional. You could instead do this:
2836
2837 @enumerate
2838 @item Link the executable as normal.
2839 @item Copy @code{foo} to @code{foo.full}
2840 @item Run @code{strip --strip-debug foo}
2841 @item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
2842 @end enumerate
2843
2844 i.e., the file pointed to by the @option{--add-gnu-debuglink} can be the
2845 full executable. It does not have to be a file created by the
2846 @option{--only-keep-debug} switch.
2847
2848 Note---this switch is only intended for use on fully linked files. It
2849 does not make sense to use it on object files where the debugging
2850 information may be incomplete. Besides the gnu_debuglink feature
2851 currently only supports the presence of one filename containing
2852 debugging information, not multiple filenames on a one-per-object-file
2853 basis.
2854
2855 @item -V
2856 @itemx --version
2857 Show the version number for @command{strip}.
2858
2859 @item -v
2860 @itemx --verbose
2861 Verbose output: list all object files modified. In the case of
2862 archives, @samp{strip -v} lists all members of the archive.
2863 @end table
2864
2865 @c man end
2866
2867 @ignore
2868 @c man begin SEEALSO strip
2869 the Info entries for @file{binutils}.
2870 @c man end
2871 @end ignore
2872
2873 @node c++filt, addr2line, elfedit, Top
2874 @chapter c++filt
2875
2876 @kindex c++filt
2877 @cindex demangling C++ symbols
2878
2879 @c man title cxxfilt Demangle C++ and Java symbols.
2880
2881 @smallexample
2882 @c man begin SYNOPSIS cxxfilt
2883 c++filt [@option{-_}|@option{--strip-underscore}]
2884 [@option{-n}|@option{--no-strip-underscore}]
2885 [@option{-p}|@option{--no-params}]
2886 [@option{-t}|@option{--types}]
2887 [@option{-i}|@option{--no-verbose}]
2888 [@option{-s} @var{format}|@option{--format=}@var{format}]
2889 [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
2890 @c man end
2891 @end smallexample
2892
2893 @c man begin DESCRIPTION cxxfilt
2894
2895 @kindex cxxfilt
2896 The C++ and Java languages provide function overloading, which means
2897 that you can write many functions with the same name, providing that
2898 each function takes parameters of different types. In order to be
2899 able to distinguish these similarly named functions C++ and Java
2900 encode them into a low-level assembler name which uniquely identifies
2901 each different version. This process is known as @dfn{mangling}. The
2902 @command{c++filt}
2903 @footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
2904 MS-DOS this program is named @command{CXXFILT}.}
2905 program does the inverse mapping: it decodes (@dfn{demangles}) low-level
2906 names into user-level names so that they can be read.
2907
2908 Every alphanumeric word (consisting of letters, digits, underscores,
2909 dollars, or periods) seen in the input is a potential mangled name.
2910 If the name decodes into a C++ name, the C++ name replaces the
2911 low-level name in the output, otherwise the original word is output.
2912 In this way you can pass an entire assembler source file, containing
2913 mangled names, through @command{c++filt} and see the same source file
2914 containing demangled names.
2915
2916 You can also use @command{c++filt} to decipher individual symbols by
2917 passing them on the command line:
2918
2919 @example
2920 c++filt @var{symbol}
2921 @end example
2922
2923 If no @var{symbol} arguments are given, @command{c++filt} reads symbol
2924 names from the standard input instead. All the results are printed on
2925 the standard output. The difference between reading names from the
2926 command line versus reading names from the standard input is that
2927 command line arguments are expected to be just mangled names and no
2928 checking is performed to separate them from surrounding text. Thus
2929 for example:
2930
2931 @smallexample
2932 c++filt -n _Z1fv
2933 @end smallexample
2934
2935 will work and demangle the name to ``f()'' whereas:
2936
2937 @smallexample
2938 c++filt -n _Z1fv,
2939 @end smallexample
2940
2941 will not work. (Note the extra comma at the end of the mangled
2942 name which makes it invalid). This command however will work:
2943
2944 @smallexample
2945 echo _Z1fv, | c++filt -n
2946 @end smallexample
2947
2948 and will display ``f(),'', i.e., the demangled name followed by a
2949 trailing comma. This behaviour is because when the names are read
2950 from the standard input it is expected that they might be part of an
2951 assembler source file where there might be extra, extraneous
2952 characters trailing after a mangled name. For example:
2953
2954 @smallexample
2955 .type _Z1fv, @@function
2956 @end smallexample
2957
2958 @c man end
2959
2960 @c man begin OPTIONS cxxfilt
2961
2962 @table @env
2963 @item -_
2964 @itemx --strip-underscore
2965 On some systems, both the C and C++ compilers put an underscore in front
2966 of every name. For example, the C name @code{foo} gets the low-level
2967 name @code{_foo}. This option removes the initial underscore. Whether
2968 @command{c++filt} removes the underscore by default is target dependent.
2969
2970 @item -n
2971 @itemx --no-strip-underscore
2972 Do not remove the initial underscore.
2973
2974 @item -p
2975 @itemx --no-params
2976 When demangling the name of a function, do not display the types of
2977 the function's parameters.
2978
2979 @item -t
2980 @itemx --types
2981 Attempt to demangle types as well as function names. This is disabled
2982 by default since mangled types are normally only used internally in
2983 the compiler, and they can be confused with non-mangled names. For example,
2984 a function called ``a'' treated as a mangled type name would be
2985 demangled to ``signed char''.
2986
2987 @item -i
2988 @itemx --no-verbose
2989 Do not include implementation details (if any) in the demangled
2990 output.
2991
2992 @item -s @var{format}
2993 @itemx --format=@var{format}
2994 @command{c++filt} can decode various methods of mangling, used by
2995 different compilers. The argument to this option selects which
2996 method it uses:
2997
2998 @table @code
2999 @item auto
3000 Automatic selection based on executable (the default method)
3001 @item gnu
3002 the one used by the @sc{gnu} C++ compiler (g++)
3003 @item lucid
3004 the one used by the Lucid compiler (lcc)
3005 @item arm
3006 the one specified by the C++ Annotated Reference Manual
3007 @item hp
3008 the one used by the HP compiler (aCC)
3009 @item edg
3010 the one used by the EDG compiler
3011 @item gnu-v3
3012 the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
3013 @item java
3014 the one used by the @sc{gnu} Java compiler (gcj)
3015 @item gnat
3016 the one used by the @sc{gnu} Ada compiler (GNAT).
3017 @end table
3018
3019 @item --help
3020 Print a summary of the options to @command{c++filt} and exit.
3021
3022 @item --version
3023 Print the version number of @command{c++filt} and exit.
3024 @end table
3025
3026 @c man end
3027
3028 @ignore
3029 @c man begin SEEALSO cxxfilt
3030 the Info entries for @file{binutils}.
3031 @c man end
3032 @end ignore
3033
3034 @quotation
3035 @emph{Warning:} @command{c++filt} is a new utility, and the details of its
3036 user interface are subject to change in future releases. In particular,
3037 a command-line option may be required in the future to decode a name
3038 passed as an argument on the command line; in other words,
3039
3040 @example
3041 c++filt @var{symbol}
3042 @end example
3043
3044 @noindent
3045 may in a future release become
3046
3047 @example
3048 c++filt @var{option} @var{symbol}
3049 @end example
3050 @end quotation
3051
3052 @node addr2line
3053 @chapter addr2line
3054
3055 @kindex addr2line
3056 @cindex address to file name and line number
3057
3058 @c man title addr2line convert addresses into file names and line numbers.
3059
3060 @smallexample
3061 @c man begin SYNOPSIS addr2line
3062 addr2line [@option{-a}|@option{--addresses}]
3063 [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
3064 [@option{-C}|@option{--demangle}[=@var{style}]]
3065 [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
3066 [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
3067 [@option{-i}|@option{--inlines}]
3068 [@option{-p}|@option{--pretty-print}]
3069 [@option{-j}|@option{--section=}@var{name}]
3070 [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
3071 [addr addr @dots{}]
3072 @c man end
3073 @end smallexample
3074
3075 @c man begin DESCRIPTION addr2line
3076
3077 @command{addr2line} translates addresses into file names and line numbers.
3078 Given an address in an executable or an offset in a section of a relocatable
3079 object, it uses the debugging information to figure out which file name and
3080 line number are associated with it.
3081
3082 The executable or relocatable object to use is specified with the @option{-e}
3083 option. The default is the file @file{a.out}. The section in the relocatable
3084 object to use is specified with the @option{-j} option.
3085
3086 @command{addr2line} has two modes of operation.
3087
3088 In the first, hexadecimal addresses are specified on the command line,
3089 and @command{addr2line} displays the file name and line number for each
3090 address.
3091
3092 In the second, @command{addr2line} reads hexadecimal addresses from
3093 standard input, and prints the file name and line number for each
3094 address on standard output. In this mode, @command{addr2line} may be used
3095 in a pipe to convert dynamically chosen addresses.
3096
3097 The format of the output is @samp{FILENAME:LINENO}. The file name and
3098 line number for each input address is printed on separate lines.
3099
3100 If the @option{-f} option is used, then each @samp{FILENAME:LINENO}
3101 line is preceded by @samp{FUNCTIONNAME} which is the name of the
3102 function containing the address.
3103
3104 If the @option{-i} option is used and the code at the given address is
3105 present there because of inlining by the compiler then the
3106 @samp{@{FUNCTIONNAME@} FILENAME:LINENO} information for the inlining
3107 function will be displayed afterwards. This continues recursively
3108 until there is no more inlining to report.
3109
3110 If the @option{-a} option is used then the output is prefixed by the
3111 input address.
3112
3113 If the @option{-p} option is used then the output for each input
3114 address is displayed on one, possibly quite long, line. If
3115 @option{-p} is not used then the output is broken up into multiple
3116 lines, based on the paragraphs above.
3117
3118 If the file name or function name can not be determined,
3119 @command{addr2line} will print two question marks in their place. If the
3120 line number can not be determined, @command{addr2line} will print 0.
3121
3122 @c man end
3123
3124 @c man begin OPTIONS addr2line
3125
3126 The long and short forms of options, shown here as alternatives, are
3127 equivalent.
3128
3129 @table @env
3130 @item -a
3131 @itemx --addresses
3132 Display the address before the function name, file and line number
3133 information. The address is printed with a @samp{0x} prefix to easily
3134 identify it.
3135
3136 @item -b @var{bfdname}
3137 @itemx --target=@var{bfdname}
3138 @cindex object code format
3139 Specify that the object-code format for the object files is
3140 @var{bfdname}.
3141
3142 @item -C
3143 @itemx --demangle[=@var{style}]
3144 @cindex demangling in objdump
3145 Decode (@dfn{demangle}) low-level symbol names into user-level names.
3146 Besides removing any initial underscore prepended by the system, this
3147 makes C++ function names readable. Different compilers have different
3148 mangling styles. The optional demangling style argument can be used to
3149 choose an appropriate demangling style for your compiler. @xref{c++filt},
3150 for more information on demangling.
3151
3152 @item -e @var{filename}
3153 @itemx --exe=@var{filename}
3154 Specify the name of the executable for which addresses should be
3155 translated. The default file is @file{a.out}.
3156
3157 @item -f
3158 @itemx --functions
3159 Display function names as well as file and line number information.
3160
3161 @item -s
3162 @itemx --basenames
3163 Display only the base of each file name.
3164
3165 @item -i
3166 @itemx --inlines
3167 If the address belongs to a function that was inlined, the source
3168 information for all enclosing scopes back to the first non-inlined
3169 function will also be printed. For example, if @code{main} inlines
3170 @code{callee1} which inlines @code{callee2}, and address is from
3171 @code{callee2}, the source information for @code{callee1} and @code{main}
3172 will also be printed.
3173
3174 @item -j
3175 @itemx --section
3176 Read offsets relative to the specified section instead of absolute addresses.
3177
3178 @item -p
3179 @itemx --pretty-print
3180 Make the output more human friendly: each location are printed on one line.
3181 If option @option{-i} is specified, lines for all enclosing scopes are
3182 prefixed with @samp{(inlined by)}.
3183 @end table
3184
3185 @c man end
3186
3187 @ignore
3188 @c man begin SEEALSO addr2line
3189 Info entries for @file{binutils}.
3190 @c man end
3191 @end ignore
3192
3193 @node nlmconv
3194 @chapter nlmconv
3195
3196 @command{nlmconv} converts a relocatable object file into a NetWare
3197 Loadable Module.
3198
3199 @ignore
3200 @command{nlmconv} currently works with @samp{i386} object
3201 files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
3202 object files in @sc{elf}, or @code{a.out} format@footnote{
3203 @command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
3204 format in the Binary File Descriptor library. It has only been tested
3205 with the above formats.}.
3206 @end ignore
3207
3208 @quotation
3209 @emph{Warning:} @command{nlmconv} is not always built as part of the binary
3210 utilities, since it is only useful for NLM targets.
3211 @end quotation
3212
3213 @c man title nlmconv converts object code into an NLM.
3214
3215 @smallexample
3216 @c man begin SYNOPSIS nlmconv
3217 nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
3218 [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
3219 [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
3220 [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
3221 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3222 @var{infile} @var{outfile}
3223 @c man end
3224 @end smallexample
3225
3226 @c man begin DESCRIPTION nlmconv
3227
3228 @command{nlmconv} converts the relocatable @samp{i386} object file
3229 @var{infile} into the NetWare Loadable Module @var{outfile}, optionally
3230 reading @var{headerfile} for NLM header information. For instructions
3231 on writing the NLM command file language used in header files, see the
3232 @samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
3233 Development and Tools Overview}, which is part of the NLM Software
3234 Developer's Kit (``NLM SDK''), available from Novell, Inc.
3235 @command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
3236 @var{infile};
3237 @ifclear man
3238 see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
3239 @end ifclear
3240
3241 @command{nlmconv} can perform a link step. In other words, you can list
3242 more than one object file for input if you list them in the definitions
3243 file (rather than simply specifying one input file on the command line).
3244 In this case, @command{nlmconv} calls the linker for you.
3245
3246 @c man end
3247
3248 @c man begin OPTIONS nlmconv
3249
3250 @table @env
3251 @item -I @var{bfdname}
3252 @itemx --input-target=@var{bfdname}
3253 Object format of the input file. @command{nlmconv} can usually determine
3254 the format of a given file (so no default is necessary).
3255 @xref{Target Selection}, for more information.
3256
3257 @item -O @var{bfdname}
3258 @itemx --output-target=@var{bfdname}
3259 Object format of the output file. @command{nlmconv} infers the output
3260 format based on the input format, e.g. for a @samp{i386} input file the
3261 output format is @samp{nlm32-i386}.
3262 @xref{Target Selection}, for more information.
3263
3264 @item -T @var{headerfile}
3265 @itemx --header-file=@var{headerfile}
3266 Reads @var{headerfile} for NLM header information. For instructions on
3267 writing the NLM command file language used in header files, see@ see the
3268 @samp{linkers} section, of the @cite{NLM Development and Tools
3269 Overview}, which is part of the NLM Software Developer's Kit, available
3270 from Novell, Inc.
3271
3272 @item -d
3273 @itemx --debug
3274 Displays (on standard error) the linker command line used by @command{nlmconv}.
3275
3276 @item -l @var{linker}
3277 @itemx --linker=@var{linker}
3278 Use @var{linker} for any linking. @var{linker} can be an absolute or a
3279 relative pathname.
3280
3281 @item -h
3282 @itemx --help
3283 Prints a usage summary.
3284
3285 @item -V
3286 @itemx --version
3287 Prints the version number for @command{nlmconv}.
3288 @end table
3289
3290 @c man end
3291
3292 @ignore
3293 @c man begin SEEALSO nlmconv
3294 the Info entries for @file{binutils}.
3295 @c man end
3296 @end ignore
3297
3298 @node windmc
3299 @chapter windmc
3300
3301 @command{windmc} may be used to generator Windows message resources.
3302
3303 @quotation
3304 @emph{Warning:} @command{windmc} is not always built as part of the binary
3305 utilities, since it is only useful for Windows targets.
3306 @end quotation
3307
3308 @c man title windmc generates Windows message resources.
3309
3310 @smallexample
3311 @c man begin SYNOPSIS windmc
3312 windmc [options] input-file
3313 @c man end
3314 @end smallexample
3315
3316 @c man begin DESCRIPTION windmc
3317
3318 @command{windmc} reads message definitions from an input file (.mc) and
3319 translate them into a set of output files. The output files may be of
3320 four kinds:
3321
3322 @table @code
3323 @item h
3324 A C header file containing the message definitions.
3325
3326 @item rc
3327 A resource file compilable by the @command{windres} tool.
3328
3329 @item bin
3330 One or more binary files containing the resource data for a specific
3331 message language.
3332
3333 @item dbg
3334 A C include file that maps message id's to their symbolic name.
3335 @end table
3336
3337 The exact description of these different formats is available in
3338 documentation from Microsoft.
3339
3340 When @command{windmc} converts from the @code{mc} format to the @code{bin}
3341 format, @code{rc}, @code{h}, and optional @code{dbg} it is acting like the
3342 Windows Message Compiler.
3343
3344 @c man end
3345
3346 @c man begin OPTIONS windmc
3347
3348 @table @env
3349 @item -a
3350 @itemx --ascii_in
3351 Specifies that the input file specified is ASCII. This is the default
3352 behaviour.
3353
3354 @item -A
3355 @itemx --ascii_out
3356 Specifies that messages in the output @code{bin} files should be in ASCII
3357 format.
3358
3359 @item -b
3360 @itemx --binprefix
3361 Specifies that @code{bin} filenames should have to be prefixed by the
3362 basename of the source file.
3363
3364 @item -c
3365 @itemx --customflag
3366 Sets the customer bit in all message id's.
3367
3368 @item -C @var{codepage}
3369 @itemx --codepage_in @var{codepage}
3370 Sets the default codepage to be used to convert input file to UTF16. The
3371 default is ocdepage 1252.
3372
3373 @item -d
3374 @itemx --decimal_values
3375 Outputs the constants in the header file in decimal. Default is using
3376 hexadecimal output.
3377
3378 @item -e @var{ext}
3379 @itemx --extension @var{ext}
3380 The extension for the header file. The default is .h extension.
3381
3382 @item -F @var{target}
3383 @itemx --target @var{target}
3384 Specify the BFD format to use for a bin file as output. This
3385 is a BFD target name; you can use the @option{--help} option to see a list
3386 of supported targets. Normally @command{windmc} will use the default
3387 format, which is the first one listed by the @option{--help} option.
3388 @ifclear man
3389 @ref{Target Selection}.
3390 @end ifclear
3391
3392 @item -h @var{path}
3393 @itemx --headerdir @var{path}
3394 The target directory of the generated header file. The default is the
3395 current directory.
3396
3397 @item -H
3398 @itemx --help
3399 Displays a list of command line options and then exits.
3400
3401 @item -m @var{characters}
3402 @itemx --maxlength @var{characters}
3403 Instructs @command{windmc} to generate a warning if the length
3404 of any message exceeds the number specified.
3405
3406 @item -n
3407 @itemx --nullterminate
3408 Terminate message text in @code{bin} files by zero. By default they are
3409 terminated by CR/LF.
3410
3411 @item -o
3412 @itemx --hresult_use
3413 Not yet implemented. Instructs @code{windmc} to generate an OLE2 header
3414 file, using HRESULT definitions. Status codes are used if the flag is not
3415 specified.
3416
3417 @item -O @var{codepage}
3418 @itemx --codepage_out @var{codepage}
3419 Sets the default codepage to be used to output text files. The default
3420 is ocdepage 1252.
3421
3422 @item -r @var{path}
3423 @itemx --rcdir @var{path}
3424 The target directory for the generated @code{rc} script and the generated
3425 @code{bin} files that the resource compiler script includes. The default
3426 is the current directory.
3427
3428 @item -u
3429 @itemx --unicode_in
3430 Specifies that the input file is UTF16.
3431
3432 @item -U
3433 @itemx --unicode_out
3434 Specifies that messages in the output @code{bin} file should be in UTF16
3435 format. This is the default behaviour.
3436
3437 @item -v
3438 @item --verbose
3439 Enable verbose mode.
3440
3441 @item -V
3442 @item --version
3443 Prints the version number for @command{windmc}.
3444
3445 @item -x @var{path}
3446 @itemx --xdgb @var{path}
3447 The path of the @code{dbg} C include file that maps message id's to the
3448 symbolic name. No such file is generated without specifying the switch.
3449 @end table
3450
3451 @c man end
3452
3453 @ignore
3454 @c man begin SEEALSO windmc
3455 the Info entries for @file{binutils}.
3456 @c man end
3457 @end ignore
3458
3459 @node windres
3460 @chapter windres
3461
3462 @command{windres} may be used to manipulate Windows resources.
3463
3464 @quotation
3465 @emph{Warning:} @command{windres} is not always built as part of the binary
3466 utilities, since it is only useful for Windows targets.
3467 @end quotation
3468
3469 @c man title windres manipulate Windows resources.
3470
3471 @smallexample
3472 @c man begin SYNOPSIS windres
3473 windres [options] [input-file] [output-file]
3474 @c man end
3475 @end smallexample
3476
3477 @c man begin DESCRIPTION windres
3478
3479 @command{windres} reads resources from an input file and copies them into
3480 an output file. Either file may be in one of three formats:
3481
3482 @table @code
3483 @item rc
3484 A text format read by the Resource Compiler.
3485
3486 @item res
3487 A binary format generated by the Resource Compiler.
3488
3489 @item coff
3490 A COFF object or executable.
3491 @end table
3492
3493 The exact description of these different formats is available in
3494 documentation from Microsoft.
3495
3496 When @command{windres} converts from the @code{rc} format to the @code{res}
3497 format, it is acting like the Windows Resource Compiler. When
3498 @command{windres} converts from the @code{res} format to the @code{coff}
3499 format, it is acting like the Windows @code{CVTRES} program.
3500
3501 When @command{windres} generates an @code{rc} file, the output is similar
3502 but not identical to the format expected for the input. When an input
3503 @code{rc} file refers to an external filename, an output @code{rc} file
3504 will instead include the file contents.
3505
3506 If the input or output format is not specified, @command{windres} will
3507 guess based on the file name, or, for the input file, the file contents.
3508 A file with an extension of @file{.rc} will be treated as an @code{rc}
3509 file, a file with an extension of @file{.res} will be treated as a
3510 @code{res} file, and a file with an extension of @file{.o} or
3511 @file{.exe} will be treated as a @code{coff} file.
3512
3513 If no output file is specified, @command{windres} will print the resources
3514 in @code{rc} format to standard output.
3515
3516 The normal use is for you to write an @code{rc} file, use @command{windres}
3517 to convert it to a COFF object file, and then link the COFF file into
3518 your application. This will make the resources described in the
3519 @code{rc} file available to Windows.
3520
3521 @c man end
3522
3523 @c man begin OPTIONS windres
3524
3525 @table @env
3526 @item -i @var{filename}
3527 @itemx --input @var{filename}
3528 The name of the input file. If this option is not used, then
3529 @command{windres} will use the first non-option argument as the input file
3530 name. If there are no non-option arguments, then @command{windres} will
3531 read from standard input. @command{windres} can not read a COFF file from
3532 standard input.
3533
3534 @item -o @var{filename}
3535 @itemx --output @var{filename}
3536 The name of the output file. If this option is not used, then
3537 @command{windres} will use the first non-option argument, after any used
3538 for the input file name, as the output file name. If there is no
3539 non-option argument, then @command{windres} will write to standard output.
3540 @command{windres} can not write a COFF file to standard output. Note,
3541 for compatibility with @command{rc} the option @option{-fo} is also
3542 accepted, but its use is not recommended.
3543
3544 @item -J @var{format}
3545 @itemx --input-format @var{format}
3546 The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
3547 @samp{coff}. If no input format is specified, @command{windres} will
3548 guess, as described above.
3549
3550 @item -O @var{format}
3551 @itemx --output-format @var{format}
3552 The output format to generate. @var{format} may be @samp{res},
3553 @samp{rc}, or @samp{coff}. If no output format is specified,
3554 @command{windres} will guess, as described above.
3555
3556 @item -F @var{target}
3557 @itemx --target @var{target}
3558 Specify the BFD format to use for a COFF file as input or output. This
3559 is a BFD target name; you can use the @option{--help} option to see a list
3560 of supported targets. Normally @command{windres} will use the default
3561 format, which is the first one listed by the @option{--help} option.
3562 @ifclear man
3563 @ref{Target Selection}.
3564 @end ifclear
3565
3566 @item --preprocessor @var{program}
3567 When @command{windres} reads an @code{rc} file, it runs it through the C
3568 preprocessor first. This option may be used to specify the preprocessor
3569 to use, including any leading arguments. The default preprocessor
3570 argument is @code{gcc -E -xc-header -DRC_INVOKED}.
3571
3572 @item --preprocessor-arg @var{option}
3573 When @command{windres} reads an @code{rc} file, it runs it through
3574 the C preprocessor first. This option may be used to specify additional
3575 text to be passed to preprocessor on its command line.
3576 This option can be used multiple times to add multiple options to the
3577 preprocessor command line.
3578
3579 @item -I @var{directory}
3580 @itemx --include-dir @var{directory}
3581 Specify an include directory to use when reading an @code{rc} file.
3582 @command{windres} will pass this to the preprocessor as an @option{-I}
3583 option. @command{windres} will also search this directory when looking for
3584 files named in the @code{rc} file. If the argument passed to this command
3585 matches any of the supported @var{formats} (as described in the @option{-J}
3586 option), it will issue a deprecation warning, and behave just like the
3587 @option{-J} option. New programs should not use this behaviour. If a
3588 directory happens to match a @var{format}, simple prefix it with @samp{./}
3589 to disable the backward compatibility.
3590
3591 @item -D @var{target}
3592 @itemx --define @var{sym}[=@var{val}]
3593 Specify a @option{-D} option to pass to the preprocessor when reading an
3594 @code{rc} file.
3595
3596 @item -U @var{target}
3597 @itemx --undefine @var{sym}
3598 Specify a @option{-U} option to pass to the preprocessor when reading an
3599 @code{rc} file.
3600
3601 @item -r
3602 Ignored for compatibility with rc.
3603
3604 @item -v
3605 Enable verbose mode. This tells you what the preprocessor is if you
3606 didn't specify one.
3607
3608 @item -c @var{val}
3609 @item --codepage @var{val}
3610 Specify the default codepage to use when reading an @code{rc} file.
3611 @var{val} should be a hexadecimal prefixed by @samp{0x} or decimal
3612 codepage code. The valid range is from zero up to 0xffff, but the
3613 validity of the codepage is host and configuration dependent.
3614
3615 @item -l @var{val}
3616 @item --language @var{val}
3617 Specify the default language to use when reading an @code{rc} file.
3618 @var{val} should be a hexadecimal language code. The low eight bits are
3619 the language, and the high eight bits are the sublanguage.
3620
3621 @item --use-temp-file
3622 Use a temporary file to instead of using popen to read the output of
3623 the preprocessor. Use this option if the popen implementation is buggy
3624 on the host (eg., certain non-English language versions of Windows 95 and
3625 Windows 98 are known to have buggy popen where the output will instead
3626 go the console).
3627
3628 @item --no-use-temp-file
3629 Use popen, not a temporary file, to read the output of the preprocessor.
3630 This is the default behaviour.
3631
3632 @item -h
3633 @item --help
3634 Prints a usage summary.
3635
3636 @item -V
3637 @item --version
3638 Prints the version number for @command{windres}.
3639
3640 @item --yydebug
3641 If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
3642 this will turn on parser debugging.
3643 @end table
3644
3645 @c man end
3646
3647 @ignore
3648 @c man begin SEEALSO windres
3649 the Info entries for @file{binutils}.
3650 @c man end
3651 @end ignore
3652
3653 @node dlltool
3654 @chapter dlltool
3655 @cindex DLL
3656 @kindex dlltool
3657
3658 @command{dlltool} is used to create the files needed to create dynamic
3659 link libraries (DLLs) on systems which understand PE format image
3660 files such as Windows. A DLL contains an export table which contains
3661 information that the runtime loader needs to resolve references from a
3662 referencing program.
3663
3664 The export table is generated by this program by reading in a
3665 @file{.def} file or scanning the @file{.a} and @file{.o} files which
3666 will be in the DLL. A @file{.o} file can contain information in
3667 special @samp{.drectve} sections with export information.
3668
3669 @quotation
3670 @emph{Note:} @command{dlltool} is not always built as part of the
3671 binary utilities, since it is only useful for those targets which
3672 support DLLs.
3673 @end quotation
3674
3675 @c man title dlltool Create files needed to build and use DLLs.
3676
3677 @smallexample
3678 @c man begin SYNOPSIS dlltool
3679 dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
3680 [@option{-b}|@option{--base-file} @var{base-file-name}]
3681 [@option{-e}|@option{--output-exp} @var{exports-file-name}]
3682 [@option{-z}|@option{--output-def} @var{def-file-name}]
3683 [@option{-l}|@option{--output-lib} @var{library-file-name}]
3684 [@option{-y}|@option{--output-delaylib} @var{library-file-name}]
3685 [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
3686 [@option{--exclude-symbols} @var{list}]
3687 [@option{--no-default-excludes}]
3688 [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
3689 [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
3690 [@option{-a}|@option{--add-indirect}]
3691 [@option{-U}|@option{--add-underscore}] [@option{--add-stdcall-underscore}]
3692 [@option{-k}|@option{--kill-at}] [@option{-A}|@option{--add-stdcall-alias}]
3693 [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
3694 [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}]
3695 [@option{--use-nul-prefixed-import-tables}]
3696 [@option{-I}|@option{--identify} @var{library-file-name}] [@option{--identify-strict}]
3697 [@option{-i}|@option{--interwork}]
3698 [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
3699 [@option{-v}|@option{--verbose}]
3700 [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
3701 [@option{--no-leading-underscore}] [@option{--leading-underscore}]
3702 [object-file @dots{}]
3703 @c man end
3704 @end smallexample
3705
3706 @c man begin DESCRIPTION dlltool
3707
3708 @command{dlltool} reads its inputs, which can come from the @option{-d} and
3709 @option{-b} options as well as object files specified on the command
3710 line. It then processes these inputs and if the @option{-e} option has
3711 been specified it creates a exports file. If the @option{-l} option
3712 has been specified it creates a library file and if the @option{-z} option
3713 has been specified it creates a def file. Any or all of the @option{-e},
3714 @option{-l} and @option{-z} options can be present in one invocation of
3715 dlltool.
3716
3717 When creating a DLL, along with the source for the DLL, it is necessary
3718 to have three other files. @command{dlltool} can help with the creation of
3719 these files.
3720
3721 The first file is a @file{.def} file which specifies which functions are
3722 exported from the DLL, which functions the DLL imports, and so on. This
3723 is a text file and can be created by hand, or @command{dlltool} can be used
3724 to create it using the @option{-z} option. In this case @command{dlltool}
3725 will scan the object files specified on its command line looking for
3726 those functions which have been specially marked as being exported and
3727 put entries for them in the @file{.def} file it creates.
3728
3729 In order to mark a function as being exported from a DLL, it needs to
3730 have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
3731 section of the object file. This can be done in C by using the
3732 asm() operator:
3733
3734 @smallexample
3735 asm (".section .drectve");
3736 asm (".ascii \"-export:my_func\"");
3737
3738 int my_func (void) @{ @dots{} @}
3739 @end smallexample
3740
3741 The second file needed for DLL creation is an exports file. This file
3742 is linked with the object files that make up the body of the DLL and it
3743 handles the interface between the DLL and the outside world. This is a
3744 binary file and it can be created by giving the @option{-e} option to
3745 @command{dlltool} when it is creating or reading in a @file{.def} file.
3746
3747 The third file needed for DLL creation is the library file that programs
3748 will link with in order to access the functions in the DLL (an `import
3749 library'). This file can be created by giving the @option{-l} option to
3750 dlltool when it is creating or reading in a @file{.def} file.
3751
3752 If the @option{-y} option is specified, dlltool generates a delay-import
3753 library that can be used instead of the normal import library to allow
3754 a program to link to the dll only as soon as an imported function is
3755 called for the first time. The resulting executable will need to be
3756 linked to the static delayimp library containing __delayLoadHelper2(),
3757 which in turn will import LoadLibraryA and GetProcAddress from kernel32.
3758
3759 @command{dlltool} builds the library file by hand, but it builds the
3760 exports file by creating temporary files containing assembler statements
3761 and then assembling these. The @option{-S} command line option can be
3762 used to specify the path to the assembler that dlltool will use,
3763 and the @option{-f} option can be used to pass specific flags to that
3764 assembler. The @option{-n} can be used to prevent dlltool from deleting
3765 these temporary assembler files when it is done, and if @option{-n} is
3766 specified twice then this will prevent dlltool from deleting the
3767 temporary object files it used to build the library.
3768
3769 Here is an example of creating a DLL from a source file @samp{dll.c} and
3770 also creating a program (from an object file called @samp{program.o})
3771 that uses that DLL:
3772
3773 @smallexample
3774 gcc -c dll.c
3775 dlltool -e exports.o -l dll.lib dll.o
3776 gcc dll.o exports.o -o dll.dll
3777 gcc program.o dll.lib -o program
3778 @end smallexample
3779
3780
3781 @command{dlltool} may also be used to query an existing import library
3782 to determine the name of the DLL to which it is associated. See the
3783 description of the @option{-I} or @option{--identify} option.
3784
3785 @c man end
3786
3787 @c man begin OPTIONS dlltool
3788
3789 The command line options have the following meanings:
3790
3791 @table @env
3792
3793 @item -d @var{filename}
3794 @itemx --input-def @var{filename}
3795 @cindex input .def file
3796 Specifies the name of a @file{.def} file to be read in and processed.
3797
3798 @item -b @var{filename}
3799 @itemx --base-file @var{filename}
3800 @cindex base files
3801 Specifies the name of a base file to be read in and processed. The
3802 contents of this file will be added to the relocation section in the
3803 exports file generated by dlltool.
3804
3805 @item -e @var{filename}
3806 @itemx --output-exp @var{filename}
3807 Specifies the name of the export file to be created by dlltool.
3808
3809 @item -z @var{filename}
3810 @itemx --output-def @var{filename}
3811 Specifies the name of the @file{.def} file to be created by dlltool.
3812
3813 @item -l @var{filename}
3814 @itemx --output-lib @var{filename}
3815 Specifies the name of the library file to be created by dlltool.
3816
3817 @item -y @var{filename}
3818 @itemx --output-delaylib @var{filename}
3819 Specifies the name of the delay-import library file to be created by dlltool.
3820
3821 @item --export-all-symbols
3822 Treat all global and weak defined symbols found in the input object
3823 files as symbols to be exported. There is a small list of symbols which
3824 are not exported by default; see the @option{--no-default-excludes}
3825 option. You may add to the list of symbols to not export by using the
3826 @option{--exclude-symbols} option.
3827
3828 @item --no-export-all-symbols
3829 Only export symbols explicitly listed in an input @file{.def} file or in
3830 @samp{.drectve} sections in the input object files. This is the default
3831 behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
3832 attributes in the source code.
3833
3834 @item --exclude-symbols @var{list}
3835 Do not export the symbols in @var{list}. This is a list of symbol names
3836 separated by comma or colon characters. The symbol names should not
3837 contain a leading underscore. This is only meaningful when
3838 @option{--export-all-symbols} is used.
3839
3840 @item --no-default-excludes
3841 When @option{--export-all-symbols} is used, it will by default avoid
3842 exporting certain special symbols. The current list of symbols to avoid
3843 exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
3844 @samp{impure_ptr}. You may use the @option{--no-default-excludes} option
3845 to go ahead and export these special symbols. This is only meaningful
3846 when @option{--export-all-symbols} is used.
3847
3848 @item -S @var{path}
3849 @itemx --as @var{path}
3850 Specifies the path, including the filename, of the assembler to be used
3851 to create the exports file.
3852
3853 @item -f @var{options}
3854 @itemx --as-flags @var{options}
3855 Specifies any specific command line options to be passed to the
3856 assembler when building the exports file. This option will work even if
3857 the @option{-S} option is not used. This option only takes one argument,
3858 and if it occurs more than once on the command line, then later
3859 occurrences will override earlier occurrences. So if it is necessary to
3860 pass multiple options to the assembler they should be enclosed in
3861 double quotes.
3862
3863 @item -D @var{name}
3864 @itemx --dll-name @var{name}
3865 Specifies the name to be stored in the @file{.def} file as the name of
3866 the DLL when the @option{-e} option is used. If this option is not
3867 present, then the filename given to the @option{-e} option will be
3868 used as the name of the DLL.
3869
3870 @item -m @var{machine}
3871 @itemx -machine @var{machine}
3872 Specifies the type of machine for which the library file should be
3873 built. @command{dlltool} has a built in default type, depending upon how
3874 it was created, but this option can be used to override that. This is
3875 normally only useful when creating DLLs for an ARM processor, when the
3876 contents of the DLL are actually encode using Thumb instructions.
3877
3878 @item -a
3879 @itemx --add-indirect
3880 Specifies that when @command{dlltool} is creating the exports file it
3881 should add a section which allows the exported functions to be
3882 referenced without using the import library. Whatever the hell that
3883 means!
3884
3885 @item -U
3886 @itemx --add-underscore
3887 Specifies that when @command{dlltool} is creating the exports file it
3888 should prepend an underscore to the names of @emph{all} exported symbols.
3889
3890 @item --no-leading-underscore
3891 @item --leading-underscore
3892 Specifies whether standard symbol should be forced to be prefixed, or
3893 not.
3894
3895 @item --add-stdcall-underscore
3896 Specifies that when @command{dlltool} is creating the exports file it
3897 should prepend an underscore to the names of exported @emph{stdcall}
3898 functions. Variable names and non-stdcall function names are not modified.
3899 This option is useful when creating GNU-compatible import libs for third
3900 party DLLs that were built with MS-Windows tools.
3901
3902 @item -k
3903 @itemx --kill-at
3904 Specifies that when @command{dlltool} is creating the exports file it
3905 should not append the string @samp{@@ <number>}. These numbers are
3906 called ordinal numbers and they represent another way of accessing the
3907 function in a DLL, other than by name.
3908
3909 @item -A
3910 @itemx --add-stdcall-alias
3911 Specifies that when @command{dlltool} is creating the exports file it
3912 should add aliases for stdcall symbols without @samp{@@ <number>}
3913 in addition to the symbols with @samp{@@ <number>}.
3914
3915 @item -p
3916 @itemx --ext-prefix-alias @var{prefix}
3917 Causes @command{dlltool} to create external aliases for all DLL
3918 imports with the specified prefix. The aliases are created for both
3919 external and import symbols with no leading underscore.
3920
3921 @item -x
3922 @itemx --no-idata4
3923 Specifies that when @command{dlltool} is creating the exports and library
3924 files it should omit the @code{.idata4} section. This is for compatibility
3925 with certain operating systems.
3926
3927 @item --use-nul-prefixed-import-tables
3928 Specifies that when @command{dlltool} is creating the exports and library
3929 files it should prefix the @code{.idata4} and @code{.idata5} by zero an
3930 element. This emulates old gnu import library generation of
3931 @code{dlltool}. By default this option is turned off.
3932
3933 @item -c
3934 @itemx --no-idata5
3935 Specifies that when @command{dlltool} is creating the exports and library
3936 files it should omit the @code{.idata5} section. This is for compatibility
3937 with certain operating systems.
3938
3939 @item -I @var{filename}
3940 @itemx --identify @var{filename}
3941 Specifies that @command{dlltool} should inspect the import library
3942 indicated by @var{filename} and report, on @code{stdout}, the name(s)
3943 of the associated DLL(s). This can be performed in addition to any
3944 other operations indicated by the other options and arguments.
3945 @command{dlltool} fails if the import library does not exist or is not
3946 actually an import library. See also @option{--identify-strict}.
3947
3948 @item --identify-strict
3949 Modifies the behavior of the @option{--identify} option, such
3950 that an error is reported if @var{filename} is associated with
3951 more than one DLL.
3952
3953 @item -i
3954 @itemx --interwork
3955 Specifies that @command{dlltool} should mark the objects in the library
3956 file and exports file that it produces as supporting interworking
3957 between ARM and Thumb code.
3958
3959 @item -n
3960 @itemx --nodelete
3961 Makes @command{dlltool} preserve the temporary assembler files it used to
3962 create the exports file. If this option is repeated then dlltool will
3963 also preserve the temporary object files it uses to create the library
3964 file.
3965
3966 @item -t @var{prefix}
3967 @itemx --temp-prefix @var{prefix}
3968 Makes @command{dlltool} use @var{prefix} when constructing the names of
3969 temporary assembler and object files. By default, the temp file prefix
3970 is generated from the pid.
3971
3972 @item -v
3973 @itemx --verbose
3974 Make dlltool describe what it is doing.
3975
3976 @item -h
3977 @itemx --help
3978 Displays a list of command line options and then exits.
3979
3980 @item -V
3981 @itemx --version
3982 Displays dlltool's version number and then exits.
3983
3984 @end table
3985
3986 @c man end
3987
3988 @menu
3989 * def file format:: The format of the dlltool @file{.def} file
3990 @end menu
3991
3992 @node def file format
3993 @section The format of the @command{dlltool} @file{.def} file
3994
3995 A @file{.def} file contains any number of the following commands:
3996
3997 @table @asis
3998
3999 @item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
4000 The result is going to be named @var{name}@code{.exe}.
4001
4002 @item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
4003 The result is going to be named @var{name}@code{.dll}.
4004 Note: If you want to use LIBRARY as name then you need to quote. Otherwise
4005 this will fail due a necessary hack for libtool (see PR binutils/13710 for more
4006 details).
4007
4008 @item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) ) [ == } @var{its_name} @code{]}
4009 @item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
4010 Declares @var{name1} as an exported symbol from the DLL, with optional
4011 ordinal number @var{integer}, or declares @var{name1} as an alias
4012 (forward) of the function @var{external-name} in the DLL.
4013 If @var{its_name} is specified, this name is used as string in export table.
4014 @var{module-name}.
4015 Note: The @code{EXPORTS} has to be the last command in .def file, as keywords
4016 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4017 If you want to use LIBRARY as name then you need to quote it.
4018
4019 @item @code{IMPORTS ( (} @var{internal-name} @code{=} @var{module-name} @code{.} @var{integer} @code{) | [} @var{internal-name} @code{= ]} @var{module-name} @code{.} @var{external-name} @code{) [ == ) @var{its_name} @code{]} *}
4020 Declares that @var{external-name} or the exported function whose
4021 ordinal number is @var{integer} is to be imported from the file
4022 @var{module-name}. If @var{internal-name} is specified then this is
4023 the name that the imported function will be referred to in the body of
4024 the DLL.
4025 If @var{its_name} is specified, this name is used as string in import table.
4026 Note: The @code{IMPORTS} has to be the last command in .def file, as keywords
4027 are treated - beside @code{LIBRARY} - as simple name-identifiers.
4028 If you want to use LIBRARY as name then you need to quote it.
4029
4030 @item @code{DESCRIPTION} @var{string}
4031 Puts @var{string} into the output @file{.exp} file in the
4032 @code{.rdata} section.
4033
4034 @item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4035 @item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
4036 Generates @code{--stack} or @code{--heap}
4037 @var{number-reserve},@var{number-commit} in the output @code{.drectve}
4038 section. The linker will see this and act upon it.
4039
4040 @item @code{CODE} @var{attr} @code{+}
4041 @item @code{DATA} @var{attr} @code{+}
4042 @item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
4043 Generates @code{--attr} @var{section-name} @var{attr} in the output
4044 @code{.drectve} section, where @var{attr} is one of @code{READ},
4045 @code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
4046 this and act upon it.
4047
4048 @end table
4049
4050 @ignore
4051 @c man begin SEEALSO dlltool
4052 The Info pages for @file{binutils}.
4053 @c man end
4054 @end ignore
4055
4056 @node readelf
4057 @chapter readelf
4058
4059 @cindex ELF file information
4060 @kindex readelf
4061
4062 @c man title readelf Displays information about ELF files.
4063
4064 @smallexample
4065 @c man begin SYNOPSIS readelf
4066 readelf [@option{-a}|@option{--all}]
4067 [@option{-h}|@option{--file-header}]
4068 [@option{-l}|@option{--program-headers}|@option{--segments}]
4069 [@option{-S}|@option{--section-headers}|@option{--sections}]
4070 [@option{-g}|@option{--section-groups}]
4071 [@option{-t}|@option{--section-details}]
4072 [@option{-e}|@option{--headers}]
4073 [@option{-s}|@option{--syms}|@option{--symbols}]
4074 [@option{--dyn-syms}]
4075 [@option{-n}|@option{--notes}]
4076 [@option{-r}|@option{--relocs}]
4077 [@option{-u}|@option{--unwind}]
4078 [@option{-d}|@option{--dynamic}]
4079 [@option{-V}|@option{--version-info}]
4080 [@option{-A}|@option{--arch-specific}]
4081 [@option{-D}|@option{--use-dynamic}]
4082 [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
4083 [@option{-p} <number or name>|@option{--string-dump=}<number or name>]
4084 [@option{-R} <number or name>|@option{--relocated-dump=}<number or name>]
4085 [@option{-c}|@option{--archive-index}]
4086 [@option{-w[lLiaprmfFsoRt]}|
4087 @option{--debug-dump}[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]]
4088 [@option{--dwarf-depth=@var{n}}]
4089 [@option{--dwarf-start=@var{n}}]
4090 [@option{-I}|@option{--histogram}]
4091 [@option{-v}|@option{--version}]
4092 [@option{-W}|@option{--wide}]
4093 [@option{-H}|@option{--help}]
4094 @var{elffile}@dots{}
4095 @c man end
4096 @end smallexample
4097
4098 @c man begin DESCRIPTION readelf
4099
4100 @command{readelf} displays information about one or more ELF format object
4101 files. The options control what particular information to display.
4102
4103 @var{elffile}@dots{} are the object files to be examined. 32-bit and
4104 64-bit ELF files are supported, as are archives containing ELF files.
4105
4106 This program performs a similar function to @command{objdump} but it
4107 goes into more detail and it exists independently of the @sc{bfd}
4108 library, so if there is a bug in @sc{bfd} then readelf will not be
4109 affected.
4110
4111 @c man end
4112
4113 @c man begin OPTIONS readelf
4114
4115 The long and short forms of options, shown here as alternatives, are
4116 equivalent. At least one option besides @samp{-v} or @samp{-H} must be
4117 given.
4118
4119 @table @env
4120 @item -a
4121 @itemx --all
4122 Equivalent to specifying @option{--file-header},
4123 @option{--program-headers}, @option{--sections}, @option{--symbols},
4124 @option{--relocs}, @option{--dynamic}, @option{--notes} and
4125 @option{--version-info}.
4126
4127 @item -h
4128 @itemx --file-header
4129 @cindex ELF file header information
4130 Displays the information contained in the ELF header at the start of the
4131 file.
4132
4133 @item -l
4134 @itemx --program-headers
4135 @itemx --segments
4136 @cindex ELF program header information
4137 @cindex ELF segment information
4138 Displays the information contained in the file's segment headers, if it
4139 has any.
4140
4141 @item -S
4142 @itemx --sections
4143 @itemx --section-headers
4144 @cindex ELF section information
4145 Displays the information contained in the file's section headers, if it
4146 has any.
4147
4148 @item -g
4149 @itemx --section-groups
4150 @cindex ELF section group information
4151 Displays the information contained in the file's section groups, if it
4152 has any.
4153
4154 @item -t
4155 @itemx --section-details
4156 @cindex ELF section information
4157 Displays the detailed section information. Implies @option{-S}.
4158
4159 @item -s
4160 @itemx --symbols
4161 @itemx --syms
4162 @cindex ELF symbol table information
4163 Displays the entries in symbol table section of the file, if it has one.
4164
4165 @item --dyn-syms
4166 @cindex ELF dynamic symbol table information
4167 Displays the entries in dynamic symbol table section of the file, if it
4168 has one.
4169
4170 @item -e
4171 @itemx --headers
4172 Display all the headers in the file. Equivalent to @option{-h -l -S}.
4173
4174 @item -n
4175 @itemx --notes
4176 @cindex ELF notes
4177 Displays the contents of the NOTE segments and/or sections, if any.
4178
4179 @item -r
4180 @itemx --relocs
4181 @cindex ELF reloc information
4182 Displays the contents of the file's relocation section, if it has one.
4183
4184 @item -u
4185 @itemx --unwind
4186 @cindex unwind information
4187 Displays the contents of the file's unwind section, if it has one. Only
4188 the unwind sections for IA64 ELF files, as well as ARM unwind tables
4189 (@code{.ARM.exidx} / @code{.ARM.extab}) are currently supported.
4190
4191 @item -d
4192 @itemx --dynamic
4193 @cindex ELF dynamic section information
4194 Displays the contents of the file's dynamic section, if it has one.
4195
4196 @item -V
4197 @itemx --version-info
4198 @cindex ELF version sections informations
4199 Displays the contents of the version sections in the file, it they
4200 exist.
4201
4202 @item -A
4203 @itemx --arch-specific
4204 Displays architecture-specific information in the file, if there
4205 is any.
4206
4207 @item -D
4208 @itemx --use-dynamic
4209 When displaying symbols, this option makes @command{readelf} use the
4210 symbol hash tables in the file's dynamic section, rather than the
4211 symbol table sections.
4212
4213 @item -x <number or name>
4214 @itemx --hex-dump=<number or name>
4215 Displays the contents of the indicated section as a hexadecimal bytes.
4216 A number identifies a particular section by index in the section table;
4217 any other string identifies all sections with that name in the object file.
4218
4219 @item -R <number or name>
4220 @itemx --relocated-dump=<number or name>
4221 Displays the contents of the indicated section as a hexadecimal
4222 bytes. A number identifies a particular section by index in the
4223 section table; any other string identifies all sections with that name
4224 in the object file. The contents of the section will be relocated
4225 before they are displayed.
4226
4227 @item -p <number or name>
4228 @itemx --string-dump=<number or name>
4229 Displays the contents of the indicated section as printable strings.
4230 A number identifies a particular section by index in the section table;
4231 any other string identifies all sections with that name in the object file.
4232
4233 @item -c
4234 @itemx --archive-index
4235 @cindex Archive file symbol index information
4236 Displays the file symbol index infomation contained in the header part
4237 of binary archives. Performs the same function as the @option{t}
4238 command to @command{ar}, but without using the BFD library. @xref{ar}.
4239
4240 @item -w[lLiaprmfFsoRt]
4241 @itemx --debug-dump[=rawline,=decodedline,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges,=pubtypes,=trace_info,=trace_abbrev,=trace_aranges,=gdb_index]
4242 Displays the contents of the debug sections in the file, if any are
4243 present. If one of the optional letters or words follows the switch
4244 then only data found in those specific sections will be dumped.
4245
4246 Note that there is no single letter option to display the content of
4247 trace sections or .gdb_index.
4248
4249 Note: the @option{=decodedline} option will display the interpreted
4250 contents of a .debug_line section whereas the @option{=rawline} option
4251 dumps the contents in a raw format.
4252
4253 Note: the @option{=frames-interp} option will display the interpreted
4254 contents of a .debug_frame section whereas the @option{=frames} option
4255 dumps the contents in a raw format.
4256
4257 Note: the output from the @option{=info} option can also be affected
4258 by the options @option{--dwarf-depth} and @option{--dwarf-start}.
4259
4260 @item --dwarf-depth=@var{n}
4261 Limit the dump of the @code{.debug_info} section to @var{n} children.
4262 This is only useful with @option{--debug-dump=info}. The default is
4263 to print all DIEs; the special value 0 for @var{n} will also have this
4264 effect.
4265
4266 With a non-zero value for @var{n}, DIEs at or deeper than @var{n}
4267 levels will not be printed. The range for @var{n} is zero-based.
4268
4269 @item --dwarf-start=@var{n}
4270 Print only DIEs beginning with the DIE numbered @var{n}. This is only
4271 useful with @option{--debug-dump=info}.
4272
4273 If specified, this option will suppress printing of any header
4274 information and all DIEs before the DIE numbered @var{n}. Only
4275 siblings and children of the specified DIE will be printed.
4276
4277 This can be used in conjunction with @option{--dwarf-depth}.
4278
4279 @item -I
4280 @itemx --histogram
4281 Display a histogram of bucket list lengths when displaying the contents
4282 of the symbol tables.
4283
4284 @item -v
4285 @itemx --version
4286 Display the version number of readelf.
4287
4288 @item -W
4289 @itemx --wide
4290 Don't break output lines to fit into 80 columns. By default
4291 @command{readelf} breaks section header and segment listing lines for
4292 64-bit ELF files, so that they fit into 80 columns. This option causes
4293 @command{readelf} to print each section header resp. each segment one a
4294 single line, which is far more readable on terminals wider than 80 columns.
4295
4296 @item -H
4297 @itemx --help
4298 Display the command line options understood by @command{readelf}.
4299
4300 @end table
4301
4302 @c man end
4303
4304 @ignore
4305 @c man begin SEEALSO readelf
4306 objdump(1), and the Info entries for @file{binutils}.
4307 @c man end
4308 @end ignore
4309
4310 @node elfedit
4311 @chapter elfedit
4312
4313 @cindex Update ELF header
4314 @kindex elfedit
4315
4316 @c man title elfedit Update the ELF header of ELF files.
4317
4318 @smallexample
4319 @c man begin SYNOPSIS elfedit
4320 elfedit [@option{--input-mach=}@var{machine}]
4321 [@option{--input-type=}@var{type}]
4322 [@option{--input-osabi=}@var{osabi}]
4323 @option{--output-mach=}@var{machine}
4324 @option{--output-type=}@var{type}
4325 @option{--output-osabi=}@var{osabi}
4326 [@option{-v}|@option{--version}]
4327 [@option{-h}|@option{--help}]
4328 @var{elffile}@dots{}
4329 @c man end
4330 @end smallexample
4331
4332 @c man begin DESCRIPTION elfedit
4333
4334 @command{elfedit} updates the ELF header of ELF files which have
4335 the matching ELF machine and file types. The options control how and
4336 which fields in the ELF header should be updated.
4337
4338 @var{elffile}@dots{} are the ELF files to be updated. 32-bit and
4339 64-bit ELF files are supported, as are archives containing ELF files.
4340 @c man end
4341
4342 @c man begin OPTIONS elfedit
4343
4344 The long and short forms of options, shown here as alternatives, are
4345 equivalent. At least one of the @option{--output-mach},
4346 @option{--output-type} and @option{--output-osabi} options must be given.
4347
4348 @table @env
4349
4350 @itemx --input-mach=@var{machine}
4351 Set the matching input ELF machine type to @var{machine}. If
4352 @option{--input-mach} isn't specified, it will match any ELF
4353 machine types.
4354
4355 The supported ELF machine types are, @var{L1OM}, @var{K1OM} and
4356 @var{x86-64}.
4357
4358 @itemx --output-mach=@var{machine}
4359 Change the ELF machine type in the ELF header to @var{machine}. The
4360 supported ELF machine types are the same as @option{--input-mach}.
4361
4362 @itemx --input-type=@var{type}
4363 Set the matching input ELF file type to @var{type}. If
4364 @option{--input-type} isn't specified, it will match any ELF file types.
4365
4366 The supported ELF file types are, @var{rel}, @var{exec} and @var{dyn}.
4367
4368 @itemx --output-type=@var{type}
4369 Change the ELF file type in the ELF header to @var{type}. The
4370 supported ELF types are the same as @option{--input-type}.
4371
4372 @itemx --input-osabi=@var{osabi}
4373 Set the matching input ELF file OSABI to @var{osabi}. If
4374 @option{--input-osabi} isn't specified, it will match any ELF OSABIs.
4375
4376 The supported ELF OSABIs are, @var{none}, @var{HPUX}, @var{NetBSD},
4377 @var{GNU}, @var{Linux} (alias for @var{GNU}),
4378 @var{Solaris}, @var{AIX}, @var{Irix},
4379 @var{FreeBSD}, @var{TRU64}, @var{Modesto}, @var{OpenBSD}, @var{OpenVMS},
4380 @var{NSK}, @var{AROS} and @var{FenixOS}.
4381
4382 @itemx --output-osabi=@var{osabi}
4383 Change the ELF OSABI in the ELF header to @var{osabi}. The
4384 supported ELF OSABI are the same as @option{--input-osabi}.
4385
4386 @item -v
4387 @itemx --version
4388 Display the version number of @command{elfedit}.
4389
4390 @item -h
4391 @itemx --help
4392 Display the command line options understood by @command{elfedit}.
4393
4394 @end table
4395
4396 @c man end
4397
4398 @ignore
4399 @c man begin SEEALSO elfedit
4400 readelf(1), and the Info entries for @file{binutils}.
4401 @c man end
4402 @end ignore
4403
4404 @node Common Options
4405 @chapter Common Options
4406
4407 The following command-line options are supported by all of the
4408 programs described in this manual.
4409
4410 @c man begin OPTIONS
4411 @table @env
4412 @include at-file.texi
4413 @c man end
4414
4415 @item --help
4416 Display the command-line options supported by the program.
4417
4418 @item --version
4419 Display the version number of the program.
4420
4421 @c man begin OPTIONS
4422 @end table
4423 @c man end
4424
4425 @node Selecting the Target System
4426 @chapter Selecting the Target System
4427
4428 You can specify two aspects of the target system to the @sc{gnu}
4429 binary file utilities, each in several ways:
4430
4431 @itemize @bullet
4432 @item
4433 the target
4434
4435 @item
4436 the architecture
4437 @end itemize
4438
4439 In the following summaries, the lists of ways to specify values are in
4440 order of decreasing precedence. The ways listed first override those
4441 listed later.
4442
4443 The commands to list valid values only list the values for which the
4444 programs you are running were configured. If they were configured with
4445 @option{--enable-targets=all}, the commands list most of the available
4446 values, but a few are left out; not all targets can be configured in at
4447 once because some of them can only be configured @dfn{native} (on hosts
4448 with the same type as the target system).
4449
4450 @menu
4451 * Target Selection::
4452 * Architecture Selection::
4453 @end menu
4454
4455 @node Target Selection
4456 @section Target Selection
4457
4458 A @dfn{target} is an object file format. A given target may be
4459 supported for multiple architectures (@pxref{Architecture Selection}).
4460 A target selection may also have variations for different operating
4461 systems or architectures.
4462
4463 The command to list valid target values is @samp{objdump -i}
4464 (the first column of output contains the relevant information).
4465
4466 Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
4467 @samp{a.out-sunos-big}.
4468
4469 You can also specify a target using a configuration triplet. This is
4470 the same sort of name that is passed to @file{configure} to specify a
4471 target. When you use a configuration triplet as an argument, it must be
4472 fully canonicalized. You can see the canonical version of a triplet by
4473 running the shell script @file{config.sub} which is included with the
4474 sources.
4475
4476 Some sample configuration triplets are: @samp{m68k-hp-bsd},
4477 @samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
4478
4479 @subheading @command{objdump} Target
4480
4481 Ways to specify:
4482
4483 @enumerate
4484 @item
4485 command line option: @option{-b} or @option{--target}
4486
4487 @item
4488 environment variable @code{GNUTARGET}
4489
4490 @item
4491 deduced from the input file
4492 @end enumerate
4493
4494 @subheading @command{objcopy} and @command{strip} Input Target
4495
4496 Ways to specify:
4497
4498 @enumerate
4499 @item
4500 command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
4501
4502 @item
4503 environment variable @code{GNUTARGET}
4504
4505 @item
4506 deduced from the input file
4507 @end enumerate
4508
4509 @subheading @command{objcopy} and @command{strip} Output Target
4510
4511 Ways to specify:
4512
4513 @enumerate
4514 @item
4515 command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
4516
4517 @item
4518 the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
4519
4520 @item
4521 environment variable @code{GNUTARGET}
4522
4523 @item
4524 deduced from the input file
4525 @end enumerate
4526
4527 @subheading @command{nm}, @command{size}, and @command{strings} Target
4528
4529 Ways to specify:
4530
4531 @enumerate
4532 @item
4533 command line option: @option{--target}
4534
4535 @item
4536 environment variable @code{GNUTARGET}
4537
4538 @item
4539 deduced from the input file
4540 @end enumerate
4541
4542 @node Architecture Selection
4543 @section Architecture Selection
4544
4545 An @dfn{architecture} is a type of @sc{cpu} on which an object file is
4546 to run. Its name may contain a colon, separating the name of the
4547 processor family from the name of the particular @sc{cpu}.
4548
4549 The command to list valid architecture values is @samp{objdump -i} (the
4550 second column contains the relevant information).
4551
4552 Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
4553
4554 @subheading @command{objdump} Architecture
4555
4556 Ways to specify:
4557
4558 @enumerate
4559 @item
4560 command line option: @option{-m} or @option{--architecture}
4561
4562 @item
4563 deduced from the input file
4564 @end enumerate
4565
4566 @subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
4567
4568 Ways to specify:
4569
4570 @enumerate
4571 @item
4572 deduced from the input file
4573 @end enumerate
4574
4575 @node Reporting Bugs
4576 @chapter Reporting Bugs
4577 @cindex bugs
4578 @cindex reporting bugs
4579
4580 Your bug reports play an essential role in making the binary utilities
4581 reliable.
4582
4583 Reporting a bug may help you by bringing a solution to your problem, or
4584 it may not. But in any case the principal function of a bug report is
4585 to help the entire community by making the next version of the binary
4586 utilities work better. Bug reports are your contribution to their
4587 maintenance.
4588
4589 In order for a bug report to serve its purpose, you must include the
4590 information that enables us to fix the bug.
4591
4592 @menu
4593 * Bug Criteria:: Have you found a bug?
4594 * Bug Reporting:: How to report bugs
4595 @end menu
4596
4597 @node Bug Criteria
4598 @section Have You Found a Bug?
4599 @cindex bug criteria
4600
4601 If you are not sure whether you have found a bug, here are some guidelines:
4602
4603 @itemize @bullet
4604 @cindex fatal signal
4605 @cindex crash
4606 @item
4607 If a binary utility gets a fatal signal, for any input whatever, that is
4608 a bug. Reliable utilities never crash.
4609
4610 @cindex error on valid input
4611 @item
4612 If a binary utility produces an error message for valid input, that is a
4613 bug.
4614
4615 @item
4616 If you are an experienced user of binary utilities, your suggestions for
4617 improvement are welcome in any case.
4618 @end itemize
4619
4620 @node Bug Reporting
4621 @section How to Report Bugs
4622 @cindex bug reports
4623 @cindex bugs, reporting
4624
4625 A number of companies and individuals offer support for @sc{gnu}
4626 products. If you obtained the binary utilities from a support
4627 organization, we recommend you contact that organization first.
4628
4629 You can find contact information for many support companies and
4630 individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
4631 distribution.
4632
4633 @ifset BUGURL
4634 In any event, we also recommend that you send bug reports for the binary
4635 utilities to @value{BUGURL}.
4636 @end ifset
4637
4638 The fundamental principle of reporting bugs usefully is this:
4639 @strong{report all the facts}. If you are not sure whether to state a
4640 fact or leave it out, state it!
4641
4642 Often people omit facts because they think they know what causes the
4643 problem and assume that some details do not matter. Thus, you might
4644 assume that the name of a file you use in an example does not matter.
4645 Well, probably it does not, but one cannot be sure. Perhaps the bug is
4646 a stray memory reference which happens to fetch from the location where
4647 that pathname is stored in memory; perhaps, if the pathname were
4648 different, the contents of that location would fool the utility into
4649 doing the right thing despite the bug. Play it safe and give a
4650 specific, complete example. That is the easiest thing for you to do,
4651 and the most helpful.
4652
4653 Keep in mind that the purpose of a bug report is to enable us to fix the bug if
4654 it is new to us. Therefore, always write your bug reports on the assumption
4655 that the bug has not been reported previously.
4656
4657 Sometimes people give a few sketchy facts and ask, ``Does this ring a
4658 bell?'' This cannot help us fix a bug, so it is basically useless. We
4659 respond by asking for enough details to enable us to investigate.
4660 You might as well expedite matters by sending them to begin with.
4661
4662 To enable us to fix the bug, you should include all these things:
4663
4664 @itemize @bullet
4665 @item
4666 The version of the utility. Each utility announces it if you start it
4667 with the @option{--version} argument.
4668
4669 Without this, we will not know whether there is any point in looking for
4670 the bug in the current version of the binary utilities.
4671
4672 @item
4673 Any patches you may have applied to the source, including any patches
4674 made to the @code{BFD} library.
4675
4676 @item
4677 The type of machine you are using, and the operating system name and
4678 version number.
4679
4680 @item
4681 What compiler (and its version) was used to compile the utilities---e.g.
4682 ``@code{gcc-2.7}''.
4683
4684 @item
4685 The command arguments you gave the utility to observe the bug. To
4686 guarantee you will not omit something important, list them all. A copy
4687 of the Makefile (or the output from make) is sufficient.
4688
4689 If we were to try to guess the arguments, we would probably guess wrong
4690 and then we might not encounter the bug.
4691
4692 @item
4693 A complete input file, or set of input files, that will reproduce the
4694 bug. If the utility is reading an object file or files, then it is
4695 generally most helpful to send the actual object files.
4696
4697 If the source files were produced exclusively using @sc{gnu} programs
4698 (e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
4699 may be OK to send the source files rather than the object files. In
4700 this case, be sure to say exactly what version of @command{gcc}, or
4701 whatever, was used to produce the object files. Also say how
4702 @command{gcc}, or whatever, was configured.
4703
4704 @item
4705 A description of what behavior you observe that you believe is
4706 incorrect. For example, ``It gets a fatal signal.''
4707
4708 Of course, if the bug is that the utility gets a fatal signal, then we
4709 will certainly notice it. But if the bug is incorrect output, we might
4710 not notice unless it is glaringly wrong. You might as well not give us
4711 a chance to make a mistake.
4712
4713 Even if the problem you experience is a fatal signal, you should still
4714 say so explicitly. Suppose something strange is going on, such as your
4715 copy of the utility is out of sync, or you have encountered a bug in
4716 the C library on your system. (This has happened!) Your copy might
4717 crash and ours would not. If you told us to expect a crash, then when
4718 ours fails to crash, we would know that the bug was not happening for
4719 us. If you had not told us to expect a crash, then we would not be able
4720 to draw any conclusion from our observations.
4721
4722 @item
4723 If you wish to suggest changes to the source, send us context diffs, as
4724 generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
4725 option. Always send diffs from the old file to the new file. If you
4726 wish to discuss something in the @command{ld} source, refer to it by
4727 context, not by line number.
4728
4729 The line numbers in our development sources will not match those in your
4730 sources. Your line numbers would convey no useful information to us.
4731 @end itemize
4732
4733 Here are some things that are not necessary:
4734
4735 @itemize @bullet
4736 @item
4737 A description of the envelope of the bug.
4738
4739 Often people who encounter a bug spend a lot of time investigating
4740 which changes to the input file will make the bug go away and which
4741 changes will not affect it.
4742
4743 This is often time consuming and not very useful, because the way we
4744 will find the bug is by running a single example under the debugger
4745 with breakpoints, not by pure deduction from a series of examples.
4746 We recommend that you save your time for something else.
4747
4748 Of course, if you can find a simpler example to report @emph{instead}
4749 of the original one, that is a convenience for us. Errors in the
4750 output will be easier to spot, running under the debugger will take
4751 less time, and so on.
4752
4753 However, simplification is not vital; if you do not want to do this,
4754 report the bug anyway and send us the entire test case you used.
4755
4756 @item
4757 A patch for the bug.
4758
4759 A patch for the bug does help us if it is a good one. But do not omit
4760 the necessary information, such as the test case, on the assumption that
4761 a patch is all we need. We might see problems with your patch and decide
4762 to fix the problem another way, or we might not understand it at all.
4763
4764 Sometimes with programs as complicated as the binary utilities it is
4765 very hard to construct an example that will make the program follow a
4766 certain path through the code. If you do not send us the example, we
4767 will not be able to construct one, so we will not be able to verify that
4768 the bug is fixed.
4769
4770 And if we cannot understand what bug you are trying to fix, or why your
4771 patch should be an improvement, we will not install it. A test case will
4772 help us to understand.
4773
4774 @item
4775 A guess about what the bug is or what it depends on.
4776
4777 Such guesses are usually wrong. Even we cannot guess right about such
4778 things without first using the debugger to find the facts.
4779 @end itemize
4780
4781 @node GNU Free Documentation License
4782 @appendix GNU Free Documentation License
4783
4784 @include fdl.texi
4785
4786 @node Binutils Index
4787 @unnumbered Binutils Index
4788
4789 @printindex cp
4790
4791 @bye
This page took 0.240518 seconds and 5 git commands to generate.