Correct tx49 sanitation.
[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
54f74247 16Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 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
54f74247 44@c Copyright (C) 1991, 92, 93, 94, 95, 96, 1997 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
54f74247 69Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 1997 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
ILT
962@item --gap-fill @var{val}
963Fill gaps between sections with @var{val}. This is done by increasing
964the size of the section with the lower address, and filling in the extra
965space created with @var{val}.
966
33e0a06d
ILT
967@item --pad-to @var{address}
968Pad the output file up to the virtual address @var{address}. This is
969done by increasing the size of the last section. The extra space is
970filled in with the value specified by @samp{--gap-fill} (default zero).
971
6c7ed084
ILT
972@item --set-start @var{val}
973Set the address of the new file to @var{val}. Not all object file
a6afc090 974formats support setting the start address.
6c7ed084
ILT
975
976@item --adjust-start @var{incr}
977Adjust the start address by adding @var{incr}. Not all object file
978formats support setting the start address.
979
980@item --adjust-vma @var{incr}
981Adjust the address of all sections, as well as the start address, by
982adding @var{incr}. Some object file formats do not permit section
983addresses to be changed arbitrarily. Note that this does not relocate
984the sections; if the program expects sections to be loaded at a certain
985address, and this option is used to change the sections such that they
986are loaded at a different address, the program may fail.
987
988@item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
989Set or adjust the address of the named @var{section}. If @samp{=} is
990used, the section address is set to @var{val}. Otherwise, @var{val} is
991added to or subtracted from the section address. See the comments under
992@samp{--adjust-vma}, above. If @var{section} does not exist in the
993input file, a warning will be issued, unless @samp{--no-adjust-warnings}
994is used.
995
996@item --adjust-warnings
997If @samp{--adjust-section-vma} is used, and the named section does not
998exist, issue a warning. This is the default.
999
1000@item --no-adjust-warnings
1001Do not issue a warning if @samp{--adjust-section-vma} is used, even if
1002the named section does not exist.
1003
5ab41086
ILT
1004@item --set-section-flags @var{section}=@var{flags}
1005Set the flags for the named section. The @var{flags} argument is a
1006comma separated string of flag names. The recognized names are
1007@samp{alloc}, @samp{load}, @samp{readonly}, @samp{code}, @samp{data},
1008and @samp{rom}. Not all flags are meaningful for all object file
1009formats.
1010
d0130cc8
ILT
1011@item --add-section @var{sectionname}=@var{filename}
1012Add a new section named @var{sectionname} while copying the file. The
1013contents of the new section are taken from the file @var{filename}. The
1014size of the section will be the size of the file. This option only
1015works on file formats which can support sections with arbitrary names.
1016
decf2865
ILT
1017@item --change-leading-char
1018Some object file formats use special characters at the start of
1019symbols. The most common such character is underscore, which compilers
1020often add before every symbol. This option tells @code{objcopy} to
1021change the leading character of every symbol when it converts between
1022object file formats. If the object file formats use the same leading
1023character, this option has no effect. Otherwise, it will add a
1024character, or remove a character, or change a character, as
1025appropriate.
1026
5da470b2
ILT
1027@item --remove-leading-char
1028If the first character of a global symbol is a special symbol leading
1029character used by the object file format, remove the character. The
1030most common symbol leading character is underscore. This option will
1031remove a leading underscore from all global symbols. This can be useful
1032if you want to link together objects of different file formats with
decf2865
ILT
1033different conventions for symbol names. This is different from
1034@code{--change-leading-char} because it always changes the symbol name
1035when appropriate, regardless of the object file format of the output
1036file.
5da470b2 1037
9a442fe8
ILT
1038@item --weaken
1039Change all global symbols in the file to be weak. This can be useful
1040when building an object which will be linked against other objects using
1041the @code{-R} option to the linker. This option is only effective when
1042using an object file format which supports weak symbols.
1043
eed5eeab
DM
1044@item -V
1045@itemx --version
1046Show the version number of @code{objcopy}.
1047
1048@item -v
1049@itemx --verbose
1050Verbose output: list all object files modified. In the case of
1051archives, @samp{objcopy -V} lists all members of the archive.
1052
1053@item --help
1054Show a summary of the options to @code{objcopy}.
1055@end table
1056
eae04238 1057@node objdump
c72af735
RP
1058@chapter objdump
1059
1060@cindex object file information
1061@kindex objdump
1062
1063@smallexample
10f2a7f6 1064objdump [ -a | --archive-headers ]
e1c14599 1065 [ -b @var{bfdname} | --target=@var{bfdname} ] [ --debugging ]
9793039f
ILT
1066 [ -C | --demangle ] [ -d | --disassemble ]
1067 [ -D | --disassemble-all ] [ --disassemble-zeroes ]
67c8c901 1068 [ -EB | -EL | --endian=@{big | little @} ]
d5464baa 1069 [ -f | --file-headers ]
eae04238 1070 [ -h | --section-headers | --headers ] [ -i | --info ]
10f2a7f6 1071 [ -j @var{section} | --section=@var{section} ]
a8e27cc6 1072 [ -l | --line-numbers ] [ -S | --source ]
7e5e9619
JO
1073 [ -m @var{machine} | --architecture=@var{machine} ]
1074 [ -r | --reloc ] [ -R | --dynamic-reloc ]
1075 [ -s | --full-contents ] [ --stabs ]
de3b08ac 1076 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
aa21a2a9 1077 [ -w | --wide ] [ --start-address=@var{address} ]
4cb99ff2 1078 [ --stop-address=@var{address} ]
5c59269f 1079 [ --prefix-addresses] [ --[no-]show-raw-insn ]
ab3a59cf 1080 [ --adjust-vma=@var{offset} ]
458bbd1f 1081 [ --version ] [ --help ]
aa21a2a9 1082 @var{objfile}@dots{}
c72af735
RP
1083@end smallexample
1084
1085@code{objdump} displays information about one or more object files.
1086The options control what particular information to display. This
1087information is mostly useful to programmers who are working on the
1088compilation tools, as opposed to programmers who just want their
1089program to compile and work.
1090
b26ac613
DM
1091@var{objfile}@dots{} are the object files to be examined. When you
1092specify archives, @code{objdump} shows information on each of the member
1093object files.
1094
c72af735 1095The long and short forms of options, shown here as alternatives, are
ed78872a 1096equivalent. At least one option besides @samp{-l} must be given.
c72af735
RP
1097
1098@table @code
c72af735 1099@item -a
eae04238 1100@itemx --archive-header
c72af735 1101@cindex archive headers
ec40bbb8 1102If any of the @var{objfile} files are archives, display the archive
c72af735
RP
1103header information (in a format similar to @samp{ls -l}). Besides the
1104information you could list with @samp{ar tv}, @samp{objdump -a} shows
1105the object file format of each archive member.
1106
ab3a59cf
ILT
1107@item --adjust-vma=@var{offset}
1108@cindex section addresses in objdump
1109@cindex VMA in objdump
1110When dumping information, first add @var{offset} to all the section
1111addresses. This is useful if the section addresses do not correspond to
1112the symbol table, which can happen when putting sections at particular
1113addresses when using a format which can not represent section addresses,
1114such as a.out.
1115
c72af735 1116@item -b @var{bfdname}
eae04238 1117@itemx --target=@var{bfdname}
c72af735 1118@cindex object code format
ec40bbb8
DM
1119Specify that the object-code format for the object files is
1120@var{bfdname}. This option may not be necessary; @var{objdump} can
1121automatically recognize many formats.
1122
1123For example,
c72af735
RP
1124@example
1125objdump -b oasys -m vax -h fu.o
1126@end example
1127@noindent
ec40bbb8
DM
1128displays summary information from the section headers (@samp{-h}) of
1129@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
c72af735
RP
1130file in the format produced by Oasys compilers. You can list the
1131formats available with the @samp{-i} option.
eae04238 1132@xref{Target Selection}, for more information.
c72af735 1133
9793039f
ILT
1134@item -C
1135@itemx --demangle
1136@cindex demangling in objdump
1137Decode (@dfn{demangle}) low-level symbol names into user-level names.
1138Besides removing any initial underscore prepended by the system, this
1139makes C++ function names readable. @xref{c++filt}, for more information
1140on demangling.
1141
e1c14599
ILT
1142@item --debugging
1143Display debugging information. This attempts to parse debugging
1144information stored in the file and print it out using a C like syntax.
1145Only certain types of debugging information have been implemented.
1146
c72af735 1147@item -d
eae04238 1148@itemx --disassemble
c72af735
RP
1149@cindex disassembling object code
1150@cindex machine instructions
d5464baa
ILT
1151Display the assembler mnemonics for the machine instructions from
1152@var{objfile}. This option only disassembles those sections which are
1153expected to contain instructions.
1154
1155@item -D
1156@itemx --disassemble-all
1157Like @samp{-d}, but disassemble the contents of all sections, not just
1158those expected to contain instructions.
c72af735 1159
51b8c416
ILT
1160@item --prefix-addresses
1161When disassembling, print the complete address on each line. This is
1162the older disassembly format.
1163
1164@item --disassemble-zeroes
1165Normally the disassembly output will skip blocks of zeroes. This
1166option directs the disassembler to disassemble those blocks, just like
1167any other data.
1168
67c8c901
ILT
1169@item -EB
1170@itemx -EL
1171@itemx --endian=@{big|little@}
1172@cindex endianness
1173@cindex disassembly endianness
1174Specify the endianness of the object files. This only affects
1175disassembly. This can be useful when disassembling a file format which
1176does not describe endianness information, such as S-records.
1177
c72af735 1178@item -f
eae04238 1179@itemx --file-header
c72af735 1180@cindex object file header
eae04238 1181Display summary information from the overall header of
ec40bbb8 1182each of the @var{objfile} files.
c72af735
RP
1183
1184@item -h
eae04238 1185@itemx --section-header
c5f0c938 1186@itemx --header
c72af735 1187@cindex section headers
eae04238 1188Display summary information from the section headers of the
c72af735
RP
1189object file.
1190
db2e6adb
DM
1191File segments may be relocated to nonstandard addresses, for example by
1192using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1193@code{ld}. However, some object file formats, such as a.out, do not
1194store the starting address of the file segments. In those situations,
1195although @code{ld} relocates the sections correctly, using @samp{objdump
1196-h} to list the file section headers cannot show the correct addresses.
1197Instead, it shows the usual addresses, which are implicit for the
1198target.
1199
b26ac613
DM
1200@item --help
1201Print a summary of the options to @code{objdump} and exit.
1202
c72af735 1203@item -i
eae04238 1204@itemx --info
c72af735
RP
1205@cindex architectures available
1206@cindex object formats available
1207Display a list showing all architectures and object formats available
ec40bbb8 1208for specification with @samp{-b} or @samp{-m}.
c72af735 1209
c72af735 1210@item -j @var{name}
eae04238 1211@itemx --section=@var{name}
c72af735 1212@cindex section information
ec40bbb8 1213Display information only for section @var{name}.
c72af735 1214
c72af735 1215@item -l
eae04238 1216@itemx --line-numbers
c72af735 1217@cindex source filenames for object files
11548211
ILT
1218Label the display (using debugging information) with the filename and
1219source line numbers corresponding to the object code or relocs shown.
1220Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
c72af735 1221
c72af735 1222@item -m @var{machine}
eae04238 1223@itemx --architecture=@var{machine}
c72af735 1224@cindex architecture
67c8c901
ILT
1225@cindex disassembly architecture
1226Specify the architecture to use when disassembling object files. This
1227can be useful when disasembling object files which do not describe
1228architecture information, such as S-records. You can list the available
1229architectures with the @samp{-i} option.
c72af735
RP
1230
1231@item -r
c5f0c938 1232@itemx --reloc
c72af735 1233@cindex relocation entries, in object file
d5464baa
ILT
1234Print the relocation entries of the file. If used with @samp{-d} or
1235@samp{-D}, the relocations are printed interspersed with the
1236disassembly.
c72af735 1237
de3b08ac
ILT
1238@item -R
1239@itemx --dynamic-reloc
1240@cindex dynamic relocation entries, in object file
1241Print the dynamic relocation entries of the file. This is only
1242meaningful for dynamic objects, such as certain types of shared
1243libraries.
1244
c72af735 1245@item -s
eae04238 1246@itemx --full-contents
c72af735
RP
1247@cindex sections, full contents
1248@cindex object file sections
1249Display the full contents of any sections requested.
1250
a8e27cc6
ILT
1251@item -S
1252@itemx --source
1253@cindex source disassembly
1254@cindex disassembly, with source
1255Display source code intermixed with disassembly, if possible. Implies
1256@samp{-d}.
1257
458bbd1f
DE
1258@item --show-raw-insn
1259When disassembling instructions, print the instruction in hex as well as
4cb99ff2
ILT
1260in symbolic form. This is the default except when
1261@code{--prefix-addresses} is used.
458bbd1f 1262
5c59269f
ILT
1263@item --no-show-raw-insn
1264When disassembling instructions, do not print the instruction bytes.
1265This is the default when @code{--prefix-addresses} is used.
1266
c5f0c938
JG
1267@item --stabs
1268@cindex stab
1269@cindex .stab
1270@cindex debug symbols
1271@cindex ELF object file format
c3c93fda
JG
1272Display the full contents of any sections requested. Display the
1273contents of the .stab and .stab.index and .stab.excl sections from an
1274ELF file. This is only useful on systems (such as Solaris 2.0) in which
1275@code{.stab} debugging symbol-table entries are carried in an ELF
1276section. In most other file formats, debugging symbol-table entries are
c5f0c938 1277interleaved with linkage symbols, and are visible in the @samp{--syms}
85d4b870
ILT
1278output. For more information on stabs symbols, see @ref{Top,Stabs,Stabs
1279Overview,stabs.info, The ``stabs'' debug format}.
c5f0c938 1280
aa21a2a9
ILT
1281@item --start-address=@var{address}
1282@cindex start-address
1283Start displaying data at the specified address. This affects the output
1284of the @code{-d}, @code{-r} and @code{-s} options.
1285
1286@item --stop-address=@var{address}
1287@cindex stop-address
1288Stop displaying data at the specified address. This affects the output
1289of the @code{-d}, @code{-r} and @code{-s} options.
1290
c72af735 1291@item -t
c5f0c938 1292@itemx --syms
c72af735 1293@cindex symbol table entries, printing
eae04238 1294Print the symbol table entries of the file.
c72af735
RP
1295This is similar to the information provided by the @samp{nm} program.
1296
de3b08ac
ILT
1297@item -T
1298@itemx --dynamic-syms
1299@cindex dynamic symbol table entries, printing
1300Print the dynamic symbol table entries of the file. This is only
1301meaningful for dynamic objects, such as certain types of shared
1302libraries. This is similar to the information provided by the @samp{nm}
1303program when given the @samp{-D} (@samp{--dynamic}) option.
1304
b26ac613
DM
1305@item --version
1306Print the version number of @code{objdump} and exit.
1307
c72af735 1308@item -x
eae04238 1309@itemx --all-header
c72af735
RP
1310@cindex all header information, object file
1311@cindex header information, all
1312Display all available header information, including the symbol table and
1313relocation entries. Using @samp{-x} is equivalent to specifying all of
1314@samp{-a -f -h -r -t}.
4b6d0f78
MM
1315
1316@item -w
1317@item --wide
1318@cindex wide output, printing
1319Format some lines for output devices that have more than 80 columns.
c72af735
RP
1320@end table
1321
eae04238 1322@node ranlib
c72af735
RP
1323@chapter ranlib
1324
1325@kindex ranlib
1326@cindex archive contents
1327@cindex symbol index
1328
1329@smallexample
4d9b5d5a 1330ranlib [-vV] @var{archive}
c72af735
RP
1331@end smallexample
1332
ec40bbb8 1333@code{ranlib} generates an index to the contents of an archive and
c72af735
RP
1334stores it in the archive. The index lists each symbol defined by a
1335member of an archive that is a relocatable object file.
1336
918c2f61 1337You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
c72af735 1338
ec40bbb8 1339An archive with such an index speeds up linking to the library and
c72af735
RP
1340allows routines in the library to call each other without regard to
1341their placement in the archive.
1342
b94ff924 1343The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
c72af735
RP
1344@code{ranlib} is completely equivalent to executing @samp{ar -s}.
1345@xref{ar}.
1346
4d9b5d5a
DM
1347@table @code
1348@item -v
1349@itemx -V
1350Show the version number of @code{ranlib}.
c3f471a4 1351@end table
4d9b5d5a 1352
eae04238 1353@node size
c72af735
RP
1354@chapter size
1355
1356@kindex size
1357@cindex section sizes
1358
1359@smallexample
4d9b5d5a
DM
1360size [ -A | -B | --format=@var{compatibility} ]
1361 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1362 [ --target=@var{bfdname} ] [ -V | --version ]
f2843a17 1363 [ @var{objfile}@dots{} ]
c72af735
RP
1364@end smallexample
1365
b94ff924 1366The @sc{gnu} @code{size} utility lists the section sizes---and the total
ec40bbb8
DM
1367size---for each of the object or archive files @var{objfile} in its
1368argument list. By default, one line of output is generated for each
1369object file or each module in an archive.
c72af735 1370
b26ac613 1371@var{objfile}@dots{} are the object files to be examined.
f2843a17 1372If none are specified, the file @code{a.out} will be used.
b26ac613 1373
c72af735 1374The command line options have the following meanings:
c72af735 1375
b26ac613 1376@table @code
c72af735
RP
1377@item -A
1378@itemx -B
ec40bbb8 1379@itemx --format=@var{compatibility}
68dd5295 1380@cindex @code{size} display format
b94ff924 1381Using one of these options, you can choose whether the output from @sc{gnu}
c72af735 1382@code{size} resembles output from System V @code{size} (using @samp{-A},
ec40bbb8
DM
1383or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1384@samp{--format=berkeley}). The default is the one-line format similar to
c72af735 1385Berkeley's.
918c2f61
PB
1386@c Bonus for doc-source readers: you can also say --format=strange (or
1387@c anything else that starts with 's') for sysv, and --format=boring (or
c72af735
RP
1388@c anything else that starts with 'b') for Berkeley.
1389
1390Here is an example of the Berkeley (default) format of output from
1391@code{size}:
1392@smallexample
eae04238 1393size --format=Berkeley ranlib size
c72af735
RP
1394text data bss dec hex filename
1395294880 81920 11592 388392 5ed28 ranlib
1396294880 81920 11888 388688 5ee50 size
1397@end smallexample
1398
1399@noindent
1400This is the same data, but displayed closer to System V conventions:
1401
1402@smallexample
eae04238 1403size --format=SysV ranlib size
c72af735
RP
1404ranlib :
1405section size addr
1406.text 294880 8192
1407.data 81920 303104
1408.bss 11592 385024
1409Total 388392
1410
1411
1412size :
1413section size addr
1414.text 294880 8192
1415.data 81920 303104
1416.bss 11888 385024
1417Total 388688
1418@end smallexample
1419
918c2f61 1420@item --help
c72af735
RP
1421Show a summary of acceptable arguments and options.
1422
1423@item -d
1424@itemx -o
1425@itemx -x
ec40bbb8 1426@itemx --radix=@var{number}
68dd5295 1427@cindex @code{size} number format
c72af735
RP
1428@cindex radix for section sizes
1429Using one of these options, you can control whether the size of each
ec40bbb8
DM
1430section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1431(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1432@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
c72af735
RP
1433values (8, 10, 16) are supported. The total size is always given in two
1434radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1435octal and hexadecimal if you're using @samp{-o}.
1436
ec40bbb8 1437@item --target=@var{bfdname}
c72af735 1438@cindex object code format
ec40bbb8
DM
1439Specify that the object-code format for @var{objfile} is
1440@var{bfdname}. This option may not be necessary; @code{size} can
eae04238
DM
1441automatically recognize many formats.
1442@xref{Target Selection}, for more information.
c72af735
RP
1443
1444@item -V
918c2f61 1445@itemx --version
4d9b5d5a 1446Display the version number of @code{size}.
c72af735
RP
1447@end table
1448
eae04238 1449@node strings
ba7c8e29
DM
1450@chapter strings
1451@kindex strings
1452@cindex listings strings
1453@cindex printing strings
1454@cindex strings, printing
1455
1456@smallexample
b26ac613 1457strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
650a49f0 1458 [--all] [--print-file-name] [--bytes=@var{min-len}]
eae04238
DM
1459 [--radix=@var{radix}] [--target=@var{bfdname}]
1460 [--help] [--version] @var{file}@dots{}
ba7c8e29
DM
1461@end smallexample
1462
b94ff924 1463For each @var{file} given, @sc{gnu} @code{strings} prints the printable
ba7c8e29 1464character sequences that are at least 4 characters long (or the number
67ace729 1465given with the options below) and are followed by an unprintable
ba7c8e29 1466character. By default, it only prints the strings from the initialized
5f057047
ILT
1467and loaded sections of object files; for other types of files, it prints
1468the strings from the whole file.
ba7c8e29
DM
1469
1470@code{strings} is mainly useful for determining the contents of non-text
1471files.
1472
1473@table @code
1474@item -a
1475@itemx --all
1476@itemx -
5f057047
ILT
1477Do not scan only the initialized and loaded sections of object files;
1478scan the whole files.
ba7c8e29
DM
1479
1480@item -f
1481@itemx --print-file-name
1482Print the name of the file before each string.
1483
b26ac613 1484@item --help
ba7c8e29
DM
1485Print a summary of the program usage on the standard output and exit.
1486
ba7c8e29 1487@itemx -@var{min-len}
b26ac613 1488@item -n @var{min-len}
ba7c8e29
DM
1489@itemx --bytes=@var{min-len}
1490Print sequences of characters that are at least @var{min-len} characters
1491long, instead of the default 4.
1492
1493@item -o
b26ac613
DM
1494Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1495act like @samp{-t d} instead. Since we can not be compatible with both
1496ways, we simply chose one.
ba7c8e29
DM
1497
1498@item -t @var{radix}
1499@itemx --radix=@var{radix}
1500Print the offset within the file before each string. The single
1501character argument specifies the radix of the offset---@samp{o} for
1502octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1503
eae04238
DM
1504@item --target=@var{bfdname}
1505@cindex object code format
1506Specify an object code format other than your system's default format.
1507@xref{Target Selection}, for more information.
1508
ba7c8e29
DM
1509@item -v
1510@itemx --version
1511Print the program version number on the standard output and exit.
1512@end table
1513
eae04238 1514@node strip
c72af735
RP
1515@chapter strip
1516
1517@kindex strip
1518@cindex removing symbols
1519@cindex discarding symbols
1815e42c 1520@cindex symbols, discarding
c72af735
RP
1521
1522@smallexample
18ef0a3d 1523strip [ -F @var{bfdname} | --target=@var{bfdname} ]
eae04238
DM
1524 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1525 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
b703c078 1526 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
dff604a7 1527 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
29c0d15c 1528 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
b703c078 1529 [ -x | --discard-all ] [ -X | --discard-locals ]
0aca460e 1530 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
2483354d 1531 [ -o @var{file} ] [ -p | --preserve-dates ]
b26ac613 1532 [ -v | --verbose ] [ -V | --version ] [ --help ]
b703c078 1533 @var{objfile}@dots{}
c72af735
RP
1534@end smallexample
1535
b94ff924 1536@sc{gnu} @code{strip} discards all symbols from object files
ec40bbb8 1537@var{objfile}. The list of object files may include archives.
b26ac613 1538At least one object file must be given.
c72af735 1539
ec40bbb8 1540@code{strip} modifies the files named in its argument,
c72af735 1541rather than writing modified copies under different names.
c72af735 1542
c72af735 1543@table @code
eae04238
DM
1544@item -F @var{bfdname}
1545@itemx --target=@var{bfdname}
b26ac613 1546Treat the original @var{objfile} as a file with the object
eae04238
DM
1547code format @var{bfdname}, and rewrite it in the same format.
1548@xref{Target Selection}, for more information.
b26ac613
DM
1549
1550@item --help
1551Show a summary of the options to @code{strip} and exit.
1552
eae04238
DM
1553@item -I @var{bfdname}
1554@itemx --input-target=@var{bfdname}
ec40bbb8 1555Treat the original @var{objfile} as a file with the object
eae04238
DM
1556code format @var{bfdname}.
1557@xref{Target Selection}, for more information.
918c2f61 1558
eae04238
DM
1559@item -O @var{bfdname}
1560@itemx --output-target=@var{bfdname}
1561Replace @var{objfile} with a file in the output format @var{bfdname}.
1562@xref{Target Selection}, for more information.
918c2f61 1563
0aca460e
ILT
1564@item -R @var{sectionname}
1565@itemx --remove-section=@var{sectionname}
1566Remove any section named @var{sectionname} from the output file. This
1567option may be given more than once. Note that using this option
1568inappropriately may make the output file unusable.
1569
b703c078
DM
1570@item -s
1571@itemx --strip-all
1572Remove all symbols.
1573
918c2f61
PB
1574@item -g
1575@itemx -S
1576@itemx --strip-debug
1577Remove debugging symbols only.
1578
9135e5f8
ILT
1579@item --strip-unneeded
1580Remove all symbols that are not needed for relocation processing.
1581
dff604a7
ILT
1582@item -K @var{symbolname}
1583@itemx --keep-symbol=@var{symbolname}
1584Keep only symbol @var{symbolname} from the source file. This option may
1585be given more than once.
1586
29c0d15c
ILT
1587@item -N @var{symbolname}
1588@itemx --strip-symbol=@var{symbolname}
dff604a7
ILT
1589Remove symbol @var{symbolname} from the source file. This option may be
1590given more than once, and may be combined with strip options other than
1591@code{-K}.
29c0d15c 1592
16c3e32a
ILT
1593@item -o @var{file}
1594Put the stripped output in @var{file}, rather than replacing the
1595existing file. When this argument is used, only one @var{objfile}
1596argument may be specified.
1597
2483354d
ILT
1598@item -p
1599@itemx --preserve-dates
1600Preserve the access and modification dates of the file.
1601
918c2f61
PB
1602@item -x
1603@itemx --discard-all
1604Remove non-global symbols.
1605
1606@item -X
1607@itemx --discard-locals
1608Remove compiler-generated local symbols.
ec40bbb8 1609(These usually start with @samp{L} or @samp{.}.)
918c2f61
PB
1610
1611@item -V
1612@itemx --version
ec40bbb8 1613Show the version number for @code{strip}.
918c2f61 1614
1815e42c 1615@item -v
918c2f61
PB
1616@itemx --verbose
1617Verbose output: list all object files modified. In the case of
1269d441 1618archives, @samp{strip -v} lists all members of the archive.
c72af735
RP
1619@end table
1620
eae04238 1621@node c++filt
b6216af2
PB
1622@chapter c++filt
1623
1624@kindex c++filt
1625@cindex demangling C++ symbols
1626
b26ac613
DM
1627@smallexample
1628c++filt [ -_ | --strip-underscores ]
6f88f031 1629 [ -n | --no-strip-underscores ]
b26ac613 1630 [ -s @var{format} | --format=@var{format} ]
d6a4c375 1631 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
b26ac613
DM
1632@end smallexample
1633
6c69b6bd
JO
1634The C++ language provides function overloading, which means that you can
1635write many functions with the same name (providing each takes parameters
1636of different types). All C++ function names are encoded into a
b26ac613 1637low-level assembly label (this process is known as
6c69b6bd
JO
1638@dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1639decodes (@dfn{demangles}) low-level names into user-level names so that
1640the linker can keep these overloaded functions from clashing.
1641
1642Every alphanumeric word (consisting of letters, digits, underscores,
1643dollars, or periods) seen in the input is a potential label. If the
1644label decodes into a C++ name, the C++ name replaces the low-level
1645name in the output.
b6216af2 1646
d6a4c375 1647You can use @code{c++filt} to decipher individual symbols:
6c69b6bd
JO
1648
1649@example
1650c++filt @var{symbol}
1651@end example
1652
d6a4c375
DM
1653If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1654names from the standard input and writes the demangled names to the
1655standard output. All results are printed on the standard output.
b6216af2 1656
b26ac613
DM
1657@table @code
1658@item -_
94e9ad77 1659@itemx --strip-underscores
b26ac613
DM
1660On some systems, both the C and C++ compilers put an underscore in front
1661of every name. For example, the C name @code{foo} gets the low-level
6f88f031
ILT
1662name @code{_foo}. This option removes the initial underscore. Whether
1663@code{c++filt} removes the underscore by default is target dependent.
1664
1665@item -n
1666@itemx --no-strip-underscores
1667Do not remove the initial underscore.
b26ac613
DM
1668
1669@item -s @var{format}
1670@itemx --format=@var{format}
b94ff924 1671@sc{gnu} @code{nm} can decode three different methods of mangling, used by
b26ac613
DM
1672different C++ compilers. The argument to this option selects which
1673method it uses:
1674
1675@table @code
1676@item gnu
b94ff924 1677the one used by the @sc{gnu} compiler (the default method)
b26ac613
DM
1678@item lucid
1679the one used by the Lucid compiler
1680@item arm
1681the one specified by the C++ Annotated Reference Manual
1682@end table
1683
1684@item --help
1685Print a summary of the options to @code{c++filt} and exit.
1686
1687@item --version
1688Print the version number of @code{c++filt} and exit.
1689@end table
b6216af2 1690
5eac46ae
JO
1691@quotation
1692@emph{Warning:} @code{c++filt} is a new utility, and the details of its
1693user interface are subject to change in future releases. In particular,
1694a command-line option may be required in the the future to decode a name
1695passed as an argument on the command line; in other words,
1696
1697@example
b26ac613 1698c++filt @var{symbol}
5eac46ae
JO
1699@end example
1700
1701@noindent
1702may in a future release become
1703
1704@example
b26ac613 1705c++filt @var{option} @var{symbol}
5eac46ae
JO
1706@end example
1707@end quotation
1708
fb38844d
ILT
1709@node addr2line
1710@chapter addr2line
1711
1712@kindex addr2line
1713@cindex address to file name and line number
1714
1715@smallexample
1716addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
1717 [ -C | --demangle ]
1718 [ -e @var{filename} | --exe=@var{filename} ]
1719 [ -f | --functions ] [ -s | --basename ]
1720 [ -H | --help ] [ -V | --version ]
1721 [ addr addr ... ]
1722@end smallexample
1723
1724@code{addr2line} translates program addresses into file names and line
1725numbers. Given an address and an executable, it uses the debugging
1726information in the executable to figure out which file name and line
1727number are associated with a given address.
1728
1729The executable to use is specified with the @code{-e} option. The
1730default is @file{a.out}.
1731
1732@code{addr2line} has two modes of operation.
1733
1734In the first, hexadecimal addresses are specified on the command line,
1735and @code{addr2line} displays the file name and line number for each
1736address.
1737
1738In the second, @code{addr2line} reads hexadecimal addresses from
1739standard input, and prints the file name and line number for each
1740address on standard output. In this mode, @code{addr2line} may be used
1741in a pipe to convert dynamically chosen addresses.
1742
1743The format of the output is @samp{FILENAME:LINENO}. The file name and
1744line number for each address is printed on a separate line. If the
1745@code{-f} option is used, then each @samp{FILENAME:LINENO} line is
1746preceded by a @samp{FUNCTIONNAME} line which is the name of the function
1747containing the address.
1748
1749If the file name or function name can not be determined,
1750@code{addr2line} will print two question marks in their place. If the
1751line number can not be determined, @code{addr2line} will print 0.
1752
1753The long and short forms of options, shown here as alternatives, are
1754equivalent.
1755
1756@table @code
1757@item -b @var{bfdname}
1758@itemx --target=@var{bfdname}
1759@cindex object code format
1760Specify that the object-code format for the object files is
1761@var{bfdname}.
1762
1763@item -C
1764@itemx --demangle
1765@cindex demangling in objdump
1766Decode (@dfn{demangle}) low-level symbol names into user-level names.
1767Besides removing any initial underscore prepended by the system, this
1768makes C++ function names readable. @xref{c++filt}, for more information
1769on demangling.
1770
1771@item -e @var{filename}
1772@itemx --exe=@var{filename}
1773Specify the name of the executable for which addresses should be
1774translated. The default file is @file{a.out}.
1775
1776@item -f
1777@itemx --functions
1778Display function names as well as file and line number information.
1779
1780@item -s
1781@itemx --basenames
1782Display only the base of each file name.
1783@end table
1784
eae04238 1785@node nlmconv
94e9ad77
JO
1786@chapter nlmconv
1787
1788@code{nlmconv} converts a relocatable object file into a NetWare
8981cac5
JO
1789Loadable Module.
1790
1791@ignore
1792@code{nlmconv} currently works with @samp{i386} object
4961ce5b
JO
1793files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1794object files in @sc{elf}, or @code{a.out} format@footnote{
1795@code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1796format in the Binary File Descriptor library. It has only been tested
1797with the above formats.}.
8981cac5 1798@end ignore
4961ce5b
JO
1799
1800@quotation
1801@emph{Warning:} @code{nlmconv} is not always built as part of the binary
1802utilities, since it is only useful for NLM targets.
1803@end quotation
94e9ad77
JO
1804
1805@smallexample
eae04238
DM
1806nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1807 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
94e9ad77 1808 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
20465f8b 1809 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
94e9ad77
JO
1810 [ -h | --help ] [ -V | --version ]
1811 @var{infile} @var{outfile}
1812@end smallexample
1813
1814@code{nlmconv} converts the relocatable @samp{i386} object file
1815@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1816reading @var{headerfile} for NLM header information. For instructions
5b0ba16d
JO
1817on writing the NLM command file language used in header files, see the
1818@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1819Development and Tools Overview}, which is part of the NLM Software
1820Developer's Kit (``NLM SDK''), available from Novell, Inc.
1821@code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
eae04238 1822@var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
5b0ba16d 1823more information.
94e9ad77 1824
20465f8b
JO
1825@code{nlmconv} can perform a link step. In other words, you can list
1826more than one object file for input if you list them in the definitions
1827file (rather than simply specifying one input file on the command line).
1828In this case, @code{nlmconv} calls the linker for you.
1829
94e9ad77 1830@table @code
eae04238
DM
1831@item -I @var{bfdname}
1832@itemx --input-target=@var{bfdname}
94e9ad77 1833Object format of the input file. @code{nlmconv} can usually determine
eae04238
DM
1834the format of a given file (so no default is necessary).
1835@xref{Target Selection}, for more information.
94e9ad77 1836
eae04238
DM
1837@item -O @var{bfdname}
1838@itemx --output-target=@var{bfdname}
94e9ad77
JO
1839Object format of the output file. @code{nlmconv} infers the output
1840format based on the input format, e.g. for a @samp{i386} input file the
eae04238
DM
1841output format is @samp{nlm32-i386}.
1842@xref{Target Selection}, for more information.
94e9ad77
JO
1843
1844@item -T @var{headerfile}
1845@itemx --header-file=@var{headerfile}
1846Reads @var{headerfile} for NLM header information. For instructions on
5b0ba16d
JO
1847writing the NLM command file language used in header files, see@ see the
1848@samp{linkers} section, of the @cite{NLM Development and Tools
1849Overview}, which is part of the NLM Software Developer's Kit, available
1850from Novell, Inc.
94e9ad77 1851
20465f8b
JO
1852@item -d
1853@itemx --debug
1854Displays (on standard error) the linker command line used by @code{nlmconv}.
1855
1856@item -l @var{linker}
1857@itemx --linker=@var{linker}
1858Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1859relative pathname.
1860
94e9ad77
JO
1861@item -h
1862@itemx --help
1863Prints a usage summary.
1864
1865@item -V
1866@itemx --version
1867Prints the version number for @code{nlmconv}.
1868@end table
1869
217947b2
ILT
1870@node windres
1871@chapter windres
1872
1873@code{windres} may be used to manipulate Windows resources.
1874
1875@quotation
1876@emph{Warning:} @code{windres} is not always built as part of the binary
1877utilities, since it is only useful for Windows targets.
1878@end quotation
1879
1880@smallexample
1881windres [options] [input-file] [output-file]
1882@end smallexample
1883
1884@code{windres} reads resources from an input file and copies them into
1885an output file. Either file may be in one of three formats:
1886
1887@table @code
1888@item rc
1889A text format read by the Resource Compiler.
1890
1891@item res
1892A binary format generated by the Resource Compiler.
1893
1894@item coff
1895A COFF object or executable.
1896@end table
1897
1898The exact description of these different formats is available in
1899documentation from Microsoft.
1900
1901When @code{windres} converts from the @code{rc} format to the @code{res}
1902format, it is acting like the Windows Resource Compiler. When
1903@code{windres} converts from the @code{res} format to the @code{coff}
1904format, it is acting like the Windows @code{CVTRES} program.
1905
1906When @code{windres} generates an @code{rc} file, the output is similar
1907but not identical to the format expected for the input. When an input
1908@code{rc} file refers to an external filename, an output @code{rc} file
1909will instead include the file contents.
1910
1911If the input or output format is not specified, @code{windres} will
1912guess based on the file name, or, for the input file, the file contents.
1913A file with an extension of @file{.rc} will be treated as an @code{rc}
1914file, a file with an extension of @file{.res} will be treated as a
1915@code{res} file, and a file with an extension of @file{.o} or
1916@file{.exe} will be treated as a @code{coff} file.
1917
1918If no output file is specified, @code{windres} will print the resources
1919in @code{rc} format to standard output.
1920
1921The normal use is for you to write an @code{rc} file, use @code{windres}
1922to convert it to a COFF object file, and then link the COFF file into
1923your application. This will make the resources described in the
1924@code{rc} file available to Windows.
1925
1926@table @code
1927@item -i @var{filename}
1928@itemx --input @var{filename}
1929The name of the input file. If this option is not used, then
1930@code{windres} will use the first non-option argument as the input file
1931name. If there are no non-option arguments, then @code{windres} will
1932read from standard input. @code{windres} can not read a COFF file from
1933standard input.
1934
1935@item -o @var{filename}
1936@itemx --output @var{filename}
1937The name of the output file. If this option is not used, then
1938@code{windres} will use the first non-option argument, after any used
1939for the input file name, as the output file name. If there is no
1940non-option argument, then @code{windres} will write to standard output.
1941@code{windres} can not write a COFF file to standard output.
1942
1943@item -I @var{format}
1944@itemx --input-format @var{format}
1945The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
1946@samp{coff}. If no input format is specified, @code{windres} will
1947guess, as described above.
1948
1949@item -O @var{format}
1950@itemx --output-format @var{format}
1951The output format to generate. @var{format} may be @samp{res},
1952@samp{rc}, or @samp{coff}. If no output format is specified,
1953@code{windres} will guess, as described above.
1954
1955@item -F @var{target}
1956@itemx --target @var{target}
1957Specify the BFD format to use for a COFF file as input or output. This
1958is a BFD target name; you can use the @code{--help} option to see a list
1959of supported targets. Normally @code{windres} will use the default
1960format, which is the first one listed by the @code{--help} option.
1961@ref{Target Selection}.
1962
1963@item --preprocessor @var{program}
1964When @code{windres} reads an @code{rc} file, it runs it through the C
1965preprocessor first. This option may be used to specify the preprocessor
1966to use, including any leading arguments. The default preprocessor
1967argument is @code{gcc -E -xc-header -DRC_INVOKED}.
1968
1969@item --include-dir @var{directory}
1970Specify an include directory to use when reading an @code{rc} file.
1971@code{windres} will pass this to the preprocessor as an @code{-I}
1972option. @code{windres} will also search this directory when looking for
1973files named in the @code{rc} file.
1974
1975@item --define @var{sym[=val]}
1976Specify a @code{-D} option to pass to the preprocessor when reading an
1977@code{rc} file.
1978
1979@item --language @var{val}
1980Specify the default language to use when reading an @code{rc} file.
1981@var{val} should be a hexadecimal language code. The low eight bits are
1982the language, and the high eight bits are the sublanguage.
1983
1984@item --help
1985Prints a usage summary.
1986
1987@item --version
1988Prints the version number for @code{windres}.
1989
1990@item --yydebug
1991If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1},
1992this will turn on parser debugging.
1993@end table
1994
eae04238
DM
1995@node Selecting The Target System
1996@chapter Selecting the target system
1997
8981cac5
JO
1998You can specify three aspects of the target system to the @sc{gnu}
1999binary file utilities, each in several ways:
eae04238
DM
2000
2001@itemize @bullet
2002@item
8981cac5 2003the target
eae04238
DM
2004
2005@item
8981cac5 2006the architecture
eae04238
DM
2007
2008@item
8981cac5 2009the linker emulation (which applies to the linker only)
eae04238
DM
2010@end itemize
2011
2012In the following summaries, the lists of ways to specify values are in
8981cac5
JO
2013order of decreasing precedence. The ways listed first override those
2014listed later.
eae04238 2015
8981cac5
JO
2016The commands to list valid values only list the values for which the
2017programs you are running were configured. If they were configured with
8490169d 2018@samp{--enable-targets=all}, the commands list most of the available
eae04238 2019values, but a few are left out; not all targets can be configured in at
8981cac5
JO
2020once because some of them can only be configured @dfn{native} (on hosts
2021with the same type as the target system).
eae04238
DM
2022
2023@menu
2024* Target Selection::
2025* Architecture Selection::
2026* Linker Emulation Selection::
2027@end menu
2028
2029@node Target Selection
8981cac5 2030@section Target Selection
eae04238
DM
2031
2032A @dfn{target} is an object file format. A given target may be
2033supported for multiple architectures (@pxref{Architecture Selection}).
8981cac5
JO
2034A target selection may also have variations for different operating
2035systems or architectures.
eae04238 2036
8981cac5
JO
2037The command to list valid target values is @samp{objdump -i}
2038(the first column of output contains the relevant information).
eae04238 2039
10f2a7f6
JO
2040Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
2041@samp{a.out-sunos-big}.
eae04238 2042
55311d1c
ILT
2043You can also specify a target using a configuration triplet. This is
2044the same sort of name that is passed to configure to specify a target.
2045When you use a configuration triplet as an argument, it must be fully
2046canonicalized. You can see the canonical version of a triplet by
2047running the shell script @file{config.sub} which is included with the
2048sources.
2049
2050Some sample configuration triplets are: @samp{m68k-hp-bsd},
2051@samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
2052
8981cac5 2053@subheading @code{objdump} Target
eae04238
DM
2054
2055Ways to specify:
2056
2057@enumerate
2058@item
8981cac5 2059command line option: @samp{-b} or @samp{--target}
eae04238
DM
2060
2061@item
2062environment variable @code{GNUTARGET}
2063
2064@item
2065deduced from the input file
2066@end enumerate
2067
8981cac5 2068@subheading @code{objcopy} and @code{strip} Input Target
eae04238
DM
2069
2070Ways to specify:
2071
2072@enumerate
2073@item
8981cac5 2074command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
eae04238
DM
2075
2076@item
2077environment variable @code{GNUTARGET}
2078
2079@item
2080deduced from the input file
2081@end enumerate
2082
8981cac5 2083@subheading @code{objcopy} and @code{strip} Output Target
eae04238
DM
2084
2085Ways to specify:
2086
2087@enumerate
2088@item
8981cac5 2089command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
eae04238
DM
2090
2091@item
8981cac5 2092the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
eae04238
DM
2093
2094@item
2095environment variable @code{GNUTARGET}
2096
2097@item
2098deduced from the input file
2099@end enumerate
2100
8981cac5 2101@subheading @code{nm}, @code{size}, and @code{strings} Target
eae04238
DM
2102
2103Ways to specify:
2104
2105@enumerate
2106@item
8981cac5 2107command line option: @samp{--target}
eae04238
DM
2108
2109@item
2110environment variable @code{GNUTARGET}
2111
2112@item
2113deduced from the input file
2114@end enumerate
2115
8981cac5 2116@subheading Linker Input Target
eae04238
DM
2117
2118Ways to specify:
2119
2120@enumerate
2121@item
8981cac5 2122command line option: @samp{-b} or @samp{--format}
eae04238
DM
2123(@pxref{Options,,Options,ld.info,Using LD})
2124
2125@item
2126script command @code{TARGET}
2127(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2128
2129@item
2130environment variable @code{GNUTARGET}
2131(@pxref{Environment,,Environment,ld.info,Using LD})
2132
2133@item
2134the default target of the selected linker emulation
2135(@pxref{Linker Emulation Selection})
2136@end enumerate
2137
8981cac5 2138@subheading Linker Output Target
eae04238
DM
2139
2140Ways to specify:
2141
2142@enumerate
2143@item
8981cac5 2144command line option: @samp{-oformat}
eae04238
DM
2145(@pxref{Options,,Options,ld.info,Using LD})
2146
2147@item
2148script command @code{OUTPUT_FORMAT}
2149(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2150
2151@item
8981cac5 2152the linker input target (see ``Linker Input Target'' above)
eae04238
DM
2153@end enumerate
2154
2155@node Architecture Selection
2156@section Architecture selection
2157
8981cac5
JO
2158An @dfn{architecture} is a type of @sc{cpu} on which an object file is
2159to run. Its name may contain a colon, separating the name of the
2160processor family from the name of the particular @sc{cpu}.
eae04238 2161
8981cac5
JO
2162The command to list valid architecture values is @samp{objdump -i} (the
2163second column contains the relevant information).
eae04238
DM
2164
2165Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
2166
8981cac5 2167@subheading @code{objdump} Architecture
eae04238
DM
2168
2169Ways to specify:
2170
2171@enumerate
2172@item
8981cac5 2173command line option: @samp{-m} or @samp{--architecture}
eae04238
DM
2174
2175@item
2176deduced from the input file
2177@end enumerate
2178
8981cac5 2179@subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
eae04238
DM
2180
2181Ways to specify:
2182
2183@enumerate
2184@item
2185deduced from the input file
2186@end enumerate
2187
8981cac5 2188@subheading Linker Input Architecture
eae04238
DM
2189
2190Ways to specify:
2191
2192@enumerate
2193@item
2194deduced from the input file
2195@end enumerate
2196
8981cac5 2197@subheading Linker Output Architecture
eae04238
DM
2198
2199Ways to specify:
2200
2201@enumerate
2202@item
2203script command @code{OUTPUT_ARCH}
2204(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
2205
2206@item
2207the default architecture from the linker output target
8981cac5 2208(@pxref{Target Selection})
eae04238
DM
2209@end enumerate
2210
2211@node Linker Emulation Selection
2212@section Linker emulation selection
2213
2214A linker @dfn{emulation} is a ``personality'' of the linker, which gives
2215the linker default values for the other aspects of the target system.
2216In particular, it consists of
2217
2218@itemize @bullet
2219@item
8981cac5 2220the linker script
eae04238
DM
2221
2222@item
8981cac5 2223the target
eae04238
DM
2224
2225@item
2226several ``hook'' functions that are run at certain stages of the linking
8981cac5 2227process to do special things that some targets require
eae04238
DM
2228@end itemize
2229
8981cac5 2230The command to list valid linker emulation values is @samp{ld -V}.
eae04238
DM
2231
2232Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
2233
2234Ways to specify:
2235
2236@enumerate
2237@item
8981cac5 2238command line option: @samp{-m}
eae04238
DM
2239(@pxref{Options,,Options,ld.info,Using LD})
2240
2241@item
2242environment variable @code{LDEMULATION}
2243
2244@item
2245compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
2246which comes from @code{EMUL} in @file{config/@var{target}.mt}
2247@end enumerate
2248
cbcfa129
ILT
2249@node Reporting Bugs
2250@chapter Reporting Bugs
2251@cindex bugs
2252@cindex reporting bugs
2253
2254Your bug reports play an essential role in making the binary utilities
2255reliable.
2256
2257Reporting a bug may help you by bringing a solution to your problem, or
2258it may not. But in any case the principal function of a bug report is
2259to help the entire community by making the next version of the binary
2260utilities work better. Bug reports are your contribution to their
2261maintenance.
2262
2263In order for a bug report to serve its purpose, you must include the
2264information that enables us to fix the bug.
2265
2266@menu
2267* Bug Criteria:: Have you found a bug?
2268* Bug Reporting:: How to report bugs
2269@end menu
2270
2271@node Bug Criteria
2272@section Have you found a bug?
2273@cindex bug criteria
2274
2275If you are not sure whether you have found a bug, here are some guidelines:
2276
2277@itemize @bullet
2278@cindex fatal signal
2279@cindex crash
2280@item
2281If a binary utility gets a fatal signal, for any input whatever, that is
2282a bug. Reliable utilities never crash.
2283
2284@cindex error on valid input
2285@item
2286If a binary utility produces an error message for valid input, that is a
2287bug.
2288
2289@item
2290If you are an experienced user of binary utilities, your suggestions for
2291improvement are welcome in any case.
2292@end itemize
2293
2294@node Bug Reporting
2295@section How to report bugs
2296@cindex bug reports
2297@cindex bugs, reporting
2298
2299A number of companies and individuals offer support for @sc{gnu}
2300products. If you obtained the binary utilities from a support
2301organization, we recommend you contact that organization first.
2302
2303You can find contact information for many support companies and
2304individuals in the file @file{etc/SERVICE} in the @sc{gnu} Emacs
2305distribution.
2306
2307In any event, we also recommend that you send bug reports for the binary
2308utilities to @samp{bug-gnu-utils@@prep.ai.mit.edu}.
2309
2310The fundamental principle of reporting bugs usefully is this:
2311@strong{report all the facts}. If you are not sure whether to state a
2312fact or leave it out, state it!
2313
2314Often people omit facts because they think they know what causes the
2315problem and assume that some details do not matter. Thus, you might
2316assume that the name of a file you use in an example does not matter.
2317Well, probably it does not, but one cannot be sure. Perhaps the bug is
2318a stray memory reference which happens to fetch from the location where
2319that pathname is stored in memory; perhaps, if the pathname were
2320different, the contents of that location would fool the utility into
2321doing the right thing despite the bug. Play it safe and give a
2322specific, complete example. That is the easiest thing for you to do,
2323and the most helpful.
2324
2325Keep in mind that the purpose of a bug report is to enable us to fix the bug if
2326it is new to us. Therefore, always write your bug reports on the assumption
2327that the bug has not been reported previously.
2328
2329Sometimes people give a few sketchy facts and ask, ``Does this ring a
2330bell?'' Those bug reports are useless, and we urge everyone to
2331@emph{refuse to respond to them} except to chide the sender to report
2332bugs properly.
2333
2334To enable us to fix the bug, you should include all these things:
2335
2336@itemize @bullet
2337@item
2338The version of the utility. Each utility announces it if you start it
2339with the @samp{--version} argument.
2340
2341Without this, we will not know whether there is any point in looking for
2342the bug in the current version of the binary utilities.
2343
2344@item
2345Any patches you may have applied to the source, including any patches
2346made to the @code{BFD} library.
2347
2348@item
2349The type of machine you are using, and the operating system name and
2350version number.
2351
2352@item
2353What compiler (and its version) was used to compile the utilities---e.g.
2354``@code{gcc-2.7}''.
2355
2356@item
2357The command arguments you gave the utility to observe the bug. To
2358guarantee you will not omit something important, list them all. A copy
2359of the Makefile (or the output from make) is sufficient.
2360
2361If we were to try to guess the arguments, we would probably guess wrong
2362and then we might not encounter the bug.
2363
2364@item
2365A complete input file, or set of input files, that will reproduce the
2366bug. If the utility is reading an object file or files, then it is
2367generally most helpful to send the actual object files, uuencoded if
2368necessary to get them through the mail system. Making them available
2369for anonymous FTP is not as good, but may be the only reasonable choice
2370for large object files.
2371
2372If the source files were produced exclusively using @sc{gnu} programs
2373(e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
2374may be OK to send the source files rather than the object files. In
2375this case, be sure to say exactly what version of @code{gcc}, or
2376whatever, was used to produce the object files. Also say how
2377@code{gcc}, or whatever, was configured.
2378
2379@item
2380A description of what behavior you observe that you believe is
2381incorrect. For example, ``It gets a fatal signal.''
2382
2383Of course, if the bug is that the utility gets a fatal signal, then we
2384will certainly notice it. But if the bug is incorrect output, we might
2385not notice unless it is glaringly wrong. You might as well not give us
2386a chance to make a mistake.
2387
2388Even if the problem you experience is a fatal signal, you should still
2389say so explicitly. Suppose something strange is going on, such as, your
2390copy of the utility is out of synch, or you have encountered a bug in
2391the C library on your system. (This has happened!) Your copy might
2392crash and ours would not. If you told us to expect a crash, then when
2393ours fails to crash, we would know that the bug was not happening for
2394us. If you had not told us to expect a crash, then we would not be able
2395to draw any conclusion from our observations.
2396
2397@item
2398If you wish to suggest changes to the source, send us context diffs, as
2399generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
2400option. Always send diffs from the old file to the new file. If you
2401even discuss something in the @code{ld} source, refer to it by context,
2402not by line number.
2403
2404The line numbers in our development sources will not match those in your
2405sources. Your line numbers would convey no useful information to us.
2406@end itemize
2407
2408Here are some things that are not necessary:
2409
2410@itemize @bullet
2411@item
2412A description of the envelope of the bug.
2413
2414Often people who encounter a bug spend a lot of time investigating
2415which changes to the input file will make the bug go away and which
2416changes will not affect it.
2417
2418This is often time consuming and not very useful, because the way we
2419will find the bug is by running a single example under the debugger
2420with breakpoints, not by pure deduction from a series of examples.
2421We recommend that you save your time for something else.
2422
2423Of course, if you can find a simpler example to report @emph{instead}
2424of the original one, that is a convenience for us. Errors in the
2425output will be easier to spot, running under the debugger will take
2426less time, and so on.
2427
2428However, simplification is not vital; if you do not want to do this,
2429report the bug anyway and send us the entire test case you used.
2430
2431@item
2432A patch for the bug.
2433
2434A patch for the bug does help us if it is a good one. But do not omit
2435the necessary information, such as the test case, on the assumption that
2436a patch is all we need. We might see problems with your patch and decide
2437to fix the problem another way, or we might not understand it at all.
2438
2439Sometimes with programs as complicated as the binary utilities it is
2440very hard to construct an example that will make the program follow a
2441certain path through the code. If you do not send us the example, we
2442will not be able to construct one, so we will not be able to verify that
2443the bug is fixed.
2444
2445And if we cannot understand what bug you are trying to fix, or why your
2446patch should be an improvement, we will not install it. A test case will
2447help us to understand.
2448
2449@item
2450A guess about what the bug is or what it depends on.
2451
2452Such guesses are usually wrong. Even we cannot guess right about such
2453things without first using the debugger to find the facts.
2454@end itemize
2455
eae04238 2456@node Index
c72af735
RP
2457@unnumbered Index
2458
2459@printindex cp
2460
2461@contents
2462@bye
This page took 0.455018 seconds and 4 git commands to generate.