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