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