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