Change aix_framedata -> rs6000_framedata
[deliverable/binutils-gdb.git] / binutils / binutils.texi
CommitLineData
765a273f 1\input texinfo @c -*- Texinfo -*-
c72af735
RP
2@setfilename binutils.info
3
9abcc3b8
RP
4@ifinfo
5@format
6START-INFO-DIR-ENTRY
20f774c1
RP
7* Binutils: (binutils). The GNU binary utilities "ar", "objcopy",
8 "objdump", "nm", "nlmconv", "size",
9 "strings", "strip", and "ranlib".
9abcc3b8
RP
10END-INFO-DIR-ENTRY
11@end format
12@end ifinfo
c72af735 13
8b2c2275 14@ifinfo
8981cac5 15Copyright @copyright{} 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
8b2c2275
RP
16
17Permission is granted to make and distribute verbatim copies of
18this manual provided the copyright notice and this permission notice
19are preserved on all copies.
20
21@ignore
22Permission is granted to process this file through TeX and print the
23results, provided the printed document carries a copying permission
24notice identical to this one except for the removal of this paragraph
25(this paragraph not being relevant to the printed manual).
26
27@end ignore
28
29Permission is granted to copy and distribute modified versions of this
30manual under the conditions for verbatim copying, provided also that
31the entire resulting derived work is distributed under the terms of a
32permission notice identical to this one.
33
34Permission is granted to copy and distribute translations of this manual
35into another language, under the above conditions for modified versions.
36@end ifinfo
37
c72af735
RP
38@synindex ky cp
39@c
df14d957 40@c This file documents the GNU binary utilities "ar", "ld", "objcopy",
ba7c8e29 41@c "objdump", "nm", "size", "strings", "strip", and "ranlib".
c72af735 42@c
e32341a7 43@c Copyright (C) 1991, 1992, 1993 Free Software Foundation, Inc.
c72af735
RP
44@c
45@c This text may be freely distributed under the terms of the GNU
46@c General Public License.
47@c
27e94bd5 48
c72af735
RP
49@setchapternewpage odd
50@settitle GNU Binary Utilities
4928b97b
RP
51@titlepage
52@finalout
c72af735 53@title The GNU Binary Utilities
b6216af2 54@subtitle Version 2.2
c72af735 55@sp 1
e32341a7 56@subtitle May 1993
c72af735 57@author Roland H. Pesch
4961ce5b 58@author Jeffrey M. Osier
c72af735
RP
59@author Cygnus Support
60@page
61
62@tex
650a49f0 63{\parskip=0pt \hfill Cygnus Support\par \hfill
c72af735
RP
64\TeX{}info \texinfoversion\par }
65@end tex
66
67@vskip 0pt plus 1filll
8981cac5 68Copyright @copyright{} 1991, 1992, 1993, 1994 Free Software Foundation, Inc.
c72af735
RP
69
70Permission is granted to make and distribute verbatim copies of
71this manual provided the copyright notice and this permission notice
72are preserved on all copies.
73
74Permission is granted to copy and distribute modified versions of this
75manual under the conditions for verbatim copying, provided also that
76the entire resulting derived work is distributed under the terms of a
77permission notice identical to this one.
78
79Permission is granted to copy and distribute translations of this manual
80into another language, under the above conditions for modified versions.
81@end titlepage
82
eae04238 83@node Top
8981cac5 84@top Introduction
c72af735
RP
85
86@cindex version
87This brief manual contains preliminary documentation for the GNU binary
b6216af2 88utilities (collectively version 2.2):
8b2c2275
RP
89
90@iftex
c72af735
RP
91@table @code
92@item ar
93Create, modify, and extract from archives
94
95@item nm
96List symbols from object files
97
eed5eeab
DM
98@item objcopy
99Copy and translate object files
100
c72af735
RP
101@item objdump
102Display information from object files
103
104@item ranlib
105Generate index to archive contents
106
107@item size
eae04238 108List file section sizes and total size
c72af735 109
ba7c8e29
DM
110@item strings
111List printable strings from files
112
c72af735
RP
113@item strip
114Discard symbols
eae04238
DM
115
116@item c++filt
117Demangle encoded C++ symbols
118
119@item nlmconv
120Convert object code into a Netware Loadable Module
c72af735 121@end table
8b2c2275 122@end iftex
c72af735
RP
123
124@menu
8b2c2275 125* ar:: Create, modify, and extract from archives
8b2c2275 126* nm:: List symbols from object files
eed5eeab 127* objcopy:: Copy and translate object files
8b2c2275
RP
128* objdump:: Display information from object files
129* ranlib:: Generate index to archive contents
130* size:: List section sizes and total size
ba7c8e29 131* strings:: List printable strings from files
8b2c2275 132* strip:: Discard symbols
b6216af2 133* c++filt:: Filter to demangle encoded C++ symbols
94e9ad77 134* nlmconv:: Converts object code into an NLM
eae04238 135* Selecting The Target System:: How these utilities determine the target.
8b2c2275 136* Index::
c72af735
RP
137@end menu
138
eae04238 139@node ar
c72af735
RP
140@chapter ar
141
142@kindex ar
143@cindex archives
144@cindex collections of files
145@smallexample
650a49f0 146ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
4d9b5d5a 147ar -M [ <mri-script ]
c72af735
RP
148@end smallexample
149
150The GNU @code{ar} program creates, modifies, and extracts from
151archives. An @dfn{archive} is a single file holding a collection of
152other files in a structure that makes it possible to retrieve
153the original individual files (called @dfn{members} of the archive).
154
155The original files' contents, mode (permissions), timestamp, owner, and
ec40bbb8 156group are preserved in the archive, and can be restored on
c72af735
RP
157extraction.
158
159@cindex name length
160GNU @code{ar} can maintain archives whose members have names of any
161length; however, depending on how @code{ar} is configured on your
ec40bbb8
DM
162system, a limit on member-name length may be imposed for compatibility
163with archive formats maintained with other tools. If it exists, the
c72af735
RP
164limit is often 15 characters (typical of formats related to a.out) or 16
165characters (typical of formats related to coff).
166
167@cindex libraries
168@code{ar} is considered a binary utility because archives of this sort
169are most often used as @dfn{libraries} holding commonly needed
170subroutines.
171
172@cindex symbol index
e31e9a8d 173@code{ar} creates an index to the symbols defined in relocatable
c72af735
RP
174object modules in the archive when you specify the modifier @samp{s}.
175Once created, this index is updated in the archive whenever @code{ar}
176makes a change to its contents (save for the @samp{q} update operation).
177An archive with such an index speeds up linking to the library, and
178allows routines in the library to call each other without regard to
179their placement in the archive.
180
918c2f61 181You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
c72af735
RP
182table. If an archive lacks the table, another form of @code{ar} called
183@code{ranlib} can be used to add just the table.
184
765a273f
RP
185@cindex compatibility, @code{ar}
186@cindex @code{ar} compatibility
187GNU @code{ar} is designed to be compatible with two different
188facilities. You can control its activity using command-line options,
189like the different varieties of @code{ar} on Unix systems; or, if you
190specify the single command-line option @samp{-M}, you can control it
191with a script supplied via standard input, like the MRI ``librarian''
192program.
193
194@menu
eae04238
DM
195* ar cmdline:: Controlling @code{ar} on the command line
196* ar scripts:: Controlling @code{ar} with a script
765a273f
RP
197@end menu
198
199@page
eae04238 200@node ar cmdline
765a273f
RP
201@section Controlling @code{ar} on the command line
202
203@smallexample
650a49f0 204ar [-]@var{p}[@var{mod} [@var{relpos}]] @var{archive} [@var{member}@dots{}]
765a273f
RP
205@end smallexample
206
207@cindex Unix compatibility, @code{ar}
208When you use @code{ar} in the Unix style, @code{ar} insists on at least two
209arguments to execute: one keyletter specifying the @emph{operation}
210(optionally accompanied by other keyletters specifying
211@emph{modifiers}), and the archive name to act on.
c72af735 212
650a49f0 213Most operations can also accept further @var{member} arguments,
c72af735
RP
214specifying particular files to operate on.
215
216GNU @code{ar} allows you to mix the operation code @var{p} and modifier
217flags @var{mod} in any order, within the first command-line argument.
218
219If you wish, you may begin the first command-line argument with a
220dash.
221
222@cindex operations on archive
223The @var{p} keyletter specifies what operation to execute; it may be
224any of the following, but you must specify only one of them:
225
226@table @code
227@item d
228@cindex deleting from archive
229@emph{Delete} modules from the archive. Specify the names of modules to
650a49f0 230be deleted as @var{member}@dots{}; the archive is untouched if you
c72af735
RP
231specify no files to delete.
232
e31e9a8d 233If you specify the @samp{v} modifier, @code{ar} lists each module
c72af735
RP
234as it is deleted.
235
236@item m
237@cindex moving in archive
238Use this operation to @emph{move} members in an archive.
239
240The ordering of members in an archive can make a difference in how
241programs are linked using the library, if a symbol is defined in more
242than one member.
243
244If no modifiers are used with @code{m}, any members you name in the
650a49f0 245@var{member} arguments are moved to the @emph{end} of the archive;
c72af735
RP
246you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a
247specified place instead.
248
249@item p
250@cindex printing from archive
251@emph{Print} the specified members of the archive, to the standard
252output file. If the @samp{v} modifier is specified, show the member
253name before copying its contents to standard output.
254
650a49f0 255If you specify no @var{member} arguments, all the files in the archive are
ec40bbb8 256printed.
c72af735
RP
257
258@item q
259@cindex quick append to archive
650a49f0 260@emph{Quick append}; add the files @var{member}@dots{} to the end of
ec40bbb8 261@var{archive}, without checking for replacement.
c72af735
RP
262
263The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
264operation; new members are always placed at the end of the archive.
265
266The modifier @samp{v} makes @code{ar} list each file as it is appended.
267
268Since the point of this operation is speed, the archive's symbol table
269index is not updated, even if it already existed; you can use @samp{ar s} or
270@code{ranlib} explicitly to update the symbol table index.
271
272@item r
273@cindex replacement in archive
650a49f0 274Insert the files @var{member}@dots{} into @var{archive} (with
ec40bbb8
DM
275@emph{replacement}). This operation differs from @samp{q} in that any
276previously existing members are deleted if their names match those being
277added.
c72af735 278
650a49f0 279If one of the files named in @var{member}@dots{} does not exist, @code{ar}
c72af735
RP
280displays an error message, and leaves undisturbed any existing members
281of the archive matching that name.
282
283By default, new members are added at the end of the file; but you may
284use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request
285placement relative to some existing member.
286
287The modifier @samp{v} used with this operation elicits a line of
288output for each file inserted, along with one of the letters @samp{a} or
289@samp{r} to indicate whether the file was appended (no old member
290deleted) or replaced.
291
292@item t
293@cindex contents of archive
294Display a @emph{table} listing the contents of @var{archive}, or those
650a49f0 295of the files listed in @var{member}@dots{} that are present in the
c72af735
RP
296archive. Normally only the member name is shown; if you also want to
297see the modes (permissions), timestamp, owner, group, and size, you can
298request that by also specifying the @samp{v} modifier.
299
650a49f0 300If you do not specify a @var{member}, all files in the archive
c72af735
RP
301are listed.
302
303@cindex repeated names in archive
304@cindex name duplication in archive
305If there is more than one file with the same name (say, @samp{fie}) in
e31e9a8d 306an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the
c72af735
RP
307first instance; to see them all, you must ask for a complete
308listing---in our example, @samp{ar t b.a}.
309@c WRS only; per Gumby, this is implementation-dependent, and in a more
310@c recent case in fact works the other way.
311
312@item x
313@cindex extract from archive
650a49f0 314@emph{Extract} members (named @var{member}) from the archive. You can
c72af735
RP
315use the @samp{v} modifier with this operation, to request that
316@code{ar} list each name as it extracts it.
317
650a49f0 318If you do not specify a @var{member}, all files in the archive
c72af735
RP
319are extracted.
320
321@end table
322
323A number of modifiers (@var{mod}) may immediately follow the @var{p}
324keyletter, to specify variations on an operation's behavior:
325
326@table @code
327@item a
328@cindex relative placement in archive
329Add new files @emph{after} an existing member of the
ec40bbb8 330archive. If you use the modifier @samp{a}, the name of an existing archive
650a49f0 331member must be present as the @var{relpos} argument, before the
c72af735
RP
332@var{archive} specification.
333
334@item b
335Add new files @emph{before} an existing member of the
ec40bbb8 336archive. If you use the modifier @samp{b}, the name of an existing archive
650a49f0 337member must be present as the @var{relpos} argument, before the
c72af735
RP
338@var{archive} specification. (same as @samp{i}).
339
340@item c
341@cindex creating archives
342@emph{Create} the archive. The specified @var{archive} is always
650a49f0 343created if it did not exist, when you request an update. But a warning is
c72af735
RP
344issued unless you specify in advance that you expect to create it, by
345using this modifier.
346
52af6a44
ILT
347@item f
348Truncate names in the archive. GNU @code{ar} will normally permit file
349names of any length. This will cause it to create archives which are
350not compatible with the native @code{ar} program on some systems. If
351this is a concern, the @samp{f} modifier may be used to truncate file
352names when putting them in the archive.
353
c72af735
RP
354@item i
355Insert new files @emph{before} an existing member of the
ec40bbb8 356archive. If you use the modifier @samp{i}, the name of an existing archive
650a49f0 357member must be present as the @var{relpos} argument, before the
c72af735
RP
358@var{archive} specification. (same as @samp{b}).
359
360@item l
361This modifier is accepted but not used.
362@c whaffor ar l modifier??? presumably compat; with
363@c what???---pesch@@cygnus.com, 25jan91
364
365@item o
366@cindex dates in archive
367Preserve the @emph{original} dates of members when extracting them. If
368you do not specify this modifier, files extracted from the archive
e31e9a8d 369are stamped with the time of extraction.
c72af735
RP
370
371@item s
372@cindex writing archive index
373Write an object-file index into the archive, or update an existing one,
374even if no other change is made to the archive. You may use this modifier
375flag either with any operation, or alone. Running @samp{ar s} on an
376archive is equivalent to running @samp{ranlib} on it.
377
378@item u
379@cindex updating an archive
b703c078 380Normally, @samp{ar r}@dots{} inserts all files
c72af735
RP
381listed into the archive. If you would like to insert @emph{only} those
382of the files you list that are newer than existing members of the same
383names, use this modifier. The @samp{u} modifier is allowed only for the
384operation @samp{r} (replace). In particular, the combination @samp{qu} is
385not allowed, since checking the timestamps would lose any speed
386advantage from the operation @samp{q}.
387
388@item v
389This modifier requests the @emph{verbose} version of an operation. Many
390operations display additional information, such as filenames processed,
391when the modifier @samp{v} is appended.
4d9b5d5a
DM
392
393@item V
394This modifier shows the version number of @code{ar}.
765a273f
RP
395@end table
396
eae04238 397@node ar scripts
765a273f
RP
398@section Controlling @code{ar} with a script
399
400@smallexample
401ar -M [ <@var{script} ]
402@end smallexample
403
404@cindex MRI compatibility, @code{ar}
405@cindex scripts, @code{ar}
406If you use the single command-line option @samp{-M} with @code{ar}, you
407can control its operation with a rudimentary command language. This
e31e9a8d 408form of @code{ar} operates interactively if standard input is coming
765a273f
RP
409directly from a terminal. During interactive use, @code{ar} prompts for
410input (the prompt is @samp{AR >}), and continues executing even after
411errors. If you redirect standard input to a script file, no prompts are
e31e9a8d 412issued, and @code{ar} abandons execution (with a nonzero exit code)
765a273f
RP
413on any error.
414
415The @code{ar} command language is @emph{not} designed to be equivalent
416to the command-line options; in fact, it provides somewhat less control
417over archives. The only purpose of the command language is to ease the
418transition to GNU @code{ar} for developers who already have scripts
419written for the MRI ``librarian'' program.
420
421The syntax for the @code{ar} command language is straightforward:
422@itemize @bullet
423@item
424commands are recognized in upper or lower case; for example, @code{LIST}
425is the same as @code{list}. In the following descriptions, commands are
426shown in upper case for clarity.
427
428@item
429a single command may appear on each line; it is the first word on the
430line.
431
432@item
433empty lines are allowed, and have no effect.
434
435@item
436comments are allowed; text after either of the characters @samp{*}
437or @samp{;} is ignored.
438
439@item
440Whenever you use a list of names as part of the argument to an @code{ar}
441command, you can separate the individual names with either commas or
442blanks. Commas are shown in the explanations below, for clarity.
443
444@item
445@samp{+} is used as a line continuation character; if @samp{+} appears
446at the end of a line, the text on the following line is considered part
447of the current command.
448@end itemize
449
450Here are the commands you can use in @code{ar} scripts, or when using
451@code{ar} interactively. Three of them have special significance:
452
453@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
454a temporary file required for most of the other commands.
455
456@code{SAVE} commits the changes so far specified by the script. Prior
457to @code{SAVE}, commands affect only the temporary copy of the current
458archive.
459
460@table @code
461@item ADDLIB @var{archive}
462@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
463Add all the contents of @var{archive} (or, if specified, each named
464@var{module} from @var{archive}) to the current archive.
465
466Requires prior use of @code{OPEN} or @code{CREATE}.
467
650a49f0 468@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
765a273f
RP
469@c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
470@c else like "ar q..."
650a49f0 471Add each named @var{member} as a module in the current archive.
765a273f
RP
472
473Requires prior use of @code{OPEN} or @code{CREATE}.
474
475@item CLEAR
476Discard the contents of the current archive, cancelling the effect of
477any operations since the last @code{SAVE}. May be executed (with no
478effect) even if no current archive is specified.
479
480@item CREATE @var{archive}
481Creates an archive, and makes it the current archive (required for many
482other commands). The new archive is created with a temporary name; it
483is not actually saved as @var{archive} until you use @code{SAVE}.
484You can overwrite existing archives; similarly, the contents of any
485existing file named @var{archive} will not be destroyed until @code{SAVE}.
486
487@item DELETE @var{module}, @var{module}, @dots{} @var{module}
488Delete each listed @var{module} from the current archive; equivalent to
489@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
490
491Requires prior use of @code{OPEN} or @code{CREATE}.
492
493@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
494@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
495List each named @var{module} present in @var{archive}. The separate
496command @code{VERBOSE} specifies the form of the output: when verbose
497output is off, output is like that of @samp{ar -t @var{archive}
b703c078
DM
498@var{module}@dots{}}. When verbose output is on, the listing is like
499@samp{ar -tv @var{archive} @var{module}@dots{}}.
765a273f
RP
500
501Output normally goes to the standard output stream; however, if you
502specify @var{outputfile} as a final argument, @code{ar} directs the
503output to that file.
504
505@item END
506Exit from @code{ar}, with a @code{0} exit code to indicate successful
507completion. This command does not save the output file; if you have
508changed the current archive since the last @code{SAVE} command, those
509changes are lost.
510
511@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
512Extract each named @var{module} from the current archive, writing them
513into the current directory as separate files. Equivalent to @samp{ar -x
b703c078 514@var{archive} @var{module}@dots{}}.
765a273f
RP
515
516Requires prior use of @code{OPEN} or @code{CREATE}.
517
518@ignore
519@c FIXME Tokens but no commands???
520@item FULLDIR
521
522@item HELP
523@end ignore
524
525@item LIST
526Display full contents of the current archive, in ``verbose'' style
527regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
528tv @var{archive}}). (This single command is a GNU @code{ld}
529enhancement, rather than present for MRI compatibility.)
530
531Requires prior use of @code{OPEN} or @code{CREATE}.
532
533@item OPEN @var{archive}
534Opens an existing archive for use as the current archive (required for
535many other commands). Any changes as the result of subsequent commands
536will not actually affect @var{archive} until you next use @code{SAVE}.
537
538@item REPLACE @var{module}, @var{module}, @dots{} @var{module}
539In the current archive, replace each existing @var{module} (named in
540the @code{REPLACE} arguments) from files in the current working directory.
541To execute this command without errors, both the file, and the module in
542the current archive, must exist.
543
544Requires prior use of @code{OPEN} or @code{CREATE}.
545
546@item VERBOSE
547Toggle an internal flag governing the output from @code{DIRECTORY}.
548When the flag is on, @code{DIRECTORY} output matches output from
b703c078 549@samp{ar -tv }@dots{}.
765a273f
RP
550
551@item SAVE
552Commit your changes to the current archive, and actually save it as a
553file with the name specified in the last @code{CREATE} or @code{OPEN}
554command.
555
556Requires prior use of @code{OPEN} or @code{CREATE}.
c72af735
RP
557
558@end table
559
8b2c2275
RP
560@iftex
561@node ld
c72af735
RP
562@chapter ld
563@cindex linker
564@kindex ld
565The GNU linker @code{ld} is now described in a separate manual.
27e94bd5 566@xref{Top,, Overview,, Using LD: the GNU linker}.
8b2c2275 567@end iftex
c72af735 568
eae04238 569@node nm
c72af735
RP
570@chapter nm
571@cindex symbols
572@kindex nm
573
574@smallexample
d6a4c375 575nm [ -a | --debug-syms ] [ -g | --extern-only ]
de3b08ac 576 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
1896790e 577 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
6cfbdb50 578 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
1896790e 579 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
6cfbdb50
DM
580 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
581 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
9eb39bca 582 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
c72af735
RP
583@end smallexample
584
b703c078 585GNU @code{nm} lists the symbols from object files @var{objfile}@dots{}.
6cfbdb50
DM
586If no object files are listed as arguments, @code{nm} assumes
587@file{a.out}.
588
589For each symbol, @code{nm} shows:
590
591@itemize @bullet
592@item
593The symbol value, in the radix selected by options (see below), or
594hexadecimal by default.
595
596@item
597The symbol type. At least the following types are used; others are, as
598well, depending on the object file format. If lowercase, the symbol is
599local; if uppercase, the symbol is global (external).
600
601@c Some more detail on exactly what these symbol types are used for
602@c would be nice.
603@table @code
604@item A
605Absolute.
606
607@item B
608BSS (uninitialized data).
609
610@item C
611Common.
612
613@item D
614Initialized data.
615
616@item I
617Indirect reference.
618
619@item T
620Text (program code).
621
622@item U
623Undefined.
624@end table
625
626@item
627The symbol name.
628@end itemize
c72af735
RP
629
630The long and short forms of options, shown here as alternatives, are
631equivalent.
632
633@table @code
6cfbdb50
DM
634@item -A
635@itemx -o
636@itemx --print-file-name
637@cindex input file name
638@cindex file name
639@cindex source file name
640Precede each symbol by the name of the input file (or archive element)
641in which it was found, rather than identifying the input file once only,
642before all of its symbols.
c72af735
RP
643
644@item -a
918c2f61 645@itemx --debug-syms
c72af735 646@cindex debugging symbols
6cfbdb50
DM
647Display all symbols, even debugger-only symbols; normally these are not
648listed.
649
68dd5295
DM
650@item -B
651@cindex @code{nm} format
652@cindex @code{nm} compatibility
d6a4c375
DM
653The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
654
655@item -C
656@itemx --demangle
657@cindex demangling C++ symbols
658Decode (@dfn{demangle}) low-level symbol names into user-level names.
659Besides removing any initial underscore prepended by the system, this
660makes C++ function names readable. @xref{c++filt}, for more information
661on demangling.
68dd5295 662
9eb39bca
ILT
663@item --no-demangle
664Do not demangle low-level symbol names. This is the default.
665
de3b08ac
ILT
666@item -D
667@itemx --dynamic
668@cindex dynamic symbols
669Display the dynamic symbols rather than the normal symbols. This is
670only meaningful for dynamic objects, such as certain types of shared
671libraries.
672
6cfbdb50
DM
673@item -f @var{format}
674@itemx --format=@var{format}
68dd5295
DM
675@cindex @code{nm} format
676@cindex @code{nm} compatibility
6cfbdb50
DM
677Use the output format @var{format}, which can be @code{bsd},
678@code{sysv}, or @code{posix}. The default is @code{bsd}.
b26ac613 679Only the first character of @var{format} is significant; it can be
6cfbdb50 680either upper or lower case.
c72af735
RP
681
682@item -g
918c2f61 683@itemx --extern-only
c72af735
RP
684@cindex external symbols
685Display only external symbols.
686
b26ac613
DM
687@item -n
688@itemx -v
689@itemx --numeric-sort
690Sort symbols numerically by their addresses, rather than alphabetically
691by their names.
692
c72af735 693@item -p
918c2f61 694@itemx --no-sort
c72af735 695@cindex sorting symbols
650a49f0 696Do not bother to sort the symbols in any order; print them in the order
6cfbdb50
DM
697encountered.
698
699@item -P
700@itemx --portability
701Use the POSIX.2 standard output format instead of the default format.
702Equivalent to @samp{-f posix}.
c72af735 703
c72af735 704@item -s
918c2f61 705@itemx --print-armap
c72af735
RP
706@cindex symbol index, listing
707When listing symbols from archive members, include the index: a mapping
ec40bbb8
DM
708(stored in the archive by @code{ar} or @code{ranlib}) of which modules
709contain definitions for which names.
c72af735 710
c72af735 711@item -r
918c2f61 712@itemx --reverse-sort
ec40bbb8 713Reverse the order of the sort (whether numeric or alphabetic); let the
c72af735
RP
714last come first.
715
1896790e
ILT
716@item --size-sort
717Sort symbols by size. The size is computed as the difference between
718the value of the symbol and the value of the symbol with the next higher
719value. The size of the symbol is printed, rather than the value.
720
6cfbdb50
DM
721@item -t @var{radix}
722@itemx --radix=@var{radix}
723Use @var{radix} as the radix for printing the symbol values. It must be
724@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
725
ec40bbb8 726@item --target=@var{bfdname}
c72af735
RP
727@cindex object code format
728Specify an object code format other than your system's default format.
eae04238 729@xref{Target Selection}, for more information.
c72af735
RP
730
731@item -u
918c2f61 732@itemx --undefined-only
c72af735
RP
733@cindex external symbols
734@cindex undefined symbols
735Display only undefined symbols (those external to each object file).
736
6cfbdb50
DM
737@item -V
738@itemx --version
b26ac613
DM
739Show the version number of @code{nm} and exit.
740
741@item --help
742Show a summary of the options to @code{nm} and exit.
c72af735
RP
743@end table
744
eae04238 745@node objcopy
eed5eeab
DM
746@chapter objcopy
747
748@smallexample
eae04238
DM
749objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
750 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
751 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
eed5eeab 752 [ -S | --strip-all ] [ -g | --strip-debug ]
dff604a7 753 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
29c0d15c 754 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
eed5eeab 755 [ -x | --discard-all ] [ -X | --discard-locals ]
f7b839f7
DM
756 [ -b @var{byte} | --byte=@var{byte} ]
757 [ -i @var{interleave} | --interleave=@var{interleave} ]
0aca460e 758 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
33e0a06d
ILT
759 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
760 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
761 [ --adjust-vma=@var{incr} ]
6c7ed084
ILT
762 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
763 [ --adjust-warnings ] [ --no-adjust-warnings ]
5ab41086 764 [ --set-section-flags=@var{section}=@var{flags} ]
d0130cc8 765 [ --add-section=@var{sectionname}=@var{filename} ]
f7b839f7 766 [ -v | --verbose ] [ -V | --version ] [ --help ]
eed5eeab
DM
767 @var{infile} [@var{outfile}]
768@end smallexample
769
8981cac5
JO
770The @sc{gnu} @code{objcopy} utility copies the contents of an object
771file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
772read and write the object files. It can write the destination object
773file in a format different from that of the source object file. The
774exact behavior of @code{objcopy} is controlled by command-line options.
eed5eeab
DM
775
776@code{objcopy} creates temporary files to do its translations and
8981cac5
JO
777deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
778translation work; it has access to all the formats described in @sc{bfd}
779and thus is able to recognize most formats without being told
780explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
eed5eeab 781
67f67ed9
ILT
782@code{objcopy} can be used to generate S-records by using an output
783target of @samp{srec} (e.g., use @samp{-O srec}).
784
785@code{objcopy} can be used to generate a raw binary file by using an
786output target of @samp{binary} (e.g., use @samp{-O binary}). When
787@code{objcopy} generates a raw binary file, it will essentially produce
788a memory dump of the contents of the input object file. All symbols and
a6afc090
ILT
789relocation information will be discarded. The memory dump will start at
790the virtual address of the lowest section copied into the output file.
67f67ed9
ILT
791
792When generating an S-record or a raw binary file, it may be helpful to
793use @samp{-S} to remove sections containing debugging information. In
794some cases @samp{-R} will be useful to remove sections which contain
795information which is not needed by the binary file.
796
eed5eeab
DM
797@table @code
798@item @var{infile}
799@itemx @var{outfile}
8981cac5 800The source and output files, respectively.
eed5eeab
DM
801If you do not specify @var{outfile}, @code{objcopy} creates a
802temporary file and destructively renames the result with
8981cac5 803the name of @var{infile}.
eed5eeab 804
eae04238
DM
805@item -I @var{bfdname}
806@itemx --input-target=@var{bfdname}
807Consider the source file's object format to be @var{bfdname}, rather than
808attempting to deduce it. @xref{Target Selection}, for more information.
eed5eeab 809
eae04238
DM
810@item -O @var{bfdname}
811@itemx --output-target=@var{bfdname}
812Write the output file using the object format @var{bfdname}.
813@xref{Target Selection}, for more information.
eed5eeab 814
eae04238
DM
815@item -F @var{bfdname}
816@itemx --target=@var{bfdname}
817Use @var{bfdname} as the object format for both the input and the output
818file; i.e., simply transfer data from source to destination with no
819translation. @xref{Target Selection}, for more information.
eed5eeab 820
0aca460e
ILT
821@item -R @var{sectionname}
822@itemx --remove-section=@var{sectionname}
823Remove any section named @var{sectionname} from the output file. This
824option may be given more than once. Note that using this option
825inappropriately may make the output file unusable.
826
eed5eeab
DM
827@item -S
828@itemx --strip-all
829Do not copy relocation and symbol information from the source file.
830
831@item -g
832@itemx --strip-debug
833Do not copy debugging symbols from the source file.
834
9135e5f8
ILT
835@item --strip-unneeded
836Strip all symbols that are not needed for relocation processing.
837
dff604a7
ILT
838@item -K @var{symbolname}
839@itemx --keep-symbol=@var{symbolname}
840Copy only symbol @var{symbolname} from the source file. This option may
841be given more than once.
842
29c0d15c
ILT
843@item -N @var{symbolname}
844@itemx --strip-symbol=@var{symbolname}
dff604a7
ILT
845Do not copy symbol @var{symbolname} from the source file. This option
846may be given more than once, and may be combined with strip options
847other than @code{-K}.
29c0d15c 848
eed5eeab
DM
849@item -x
850@itemx --discard-all
851Do not copy non-global symbols from the source file.
852@c FIXME any reason to prefer "non-global" to "local" here?
853
854@item -X
855@itemx --discard-locals
856Do not copy compiler-generated local symbols.
857(These usually start with @samp{L} or @samp{.}.)
858
db2e6adb
DM
859@item -b @var{byte}
860@itemx --byte=@var{byte}
861Keep only every @var{byte}th byte of the input file (header data is not
f7b839f7
DM
862affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
863where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
864option, or the default of 4. This option is useful for creating files
8981cac5 865to program @sc{rom}. It is typically used with an @code{srec} output
f7b839f7
DM
866target.
867
868@item -i @var{interleave}
869@itemx --interleave=@var{interleave}
8981cac5
JO
870Only copy one out of every @var{interleave} bytes. Select which byte to
871copy with the @var{-b} or @samp{--byte} option. The default is 4.
872@code{objcopy} ignores this option if you do not specify either @samp{-b} or
873@samp{--byte}.
db2e6adb 874
596d99ba
ILT
875@item --gap-fill @var{val}
876Fill gaps between sections with @var{val}. This is done by increasing
877the size of the section with the lower address, and filling in the extra
878space created with @var{val}.
879
33e0a06d
ILT
880@item --pad-to @var{address}
881Pad the output file up to the virtual address @var{address}. This is
882done by increasing the size of the last section. The extra space is
883filled in with the value specified by @samp{--gap-fill} (default zero).
884
6c7ed084
ILT
885@item --set-start @var{val}
886Set the address of the new file to @var{val}. Not all object file
a6afc090 887formats support setting the start address.
6c7ed084
ILT
888
889@item --adjust-start @var{incr}
890Adjust the start address by adding @var{incr}. Not all object file
891formats support setting the start address.
892
893@item --adjust-vma @var{incr}
894Adjust the address of all sections, as well as the start address, by
895adding @var{incr}. Some object file formats do not permit section
896addresses to be changed arbitrarily. Note that this does not relocate
897the sections; if the program expects sections to be loaded at a certain
898address, and this option is used to change the sections such that they
899are loaded at a different address, the program may fail.
900
901@item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
902Set or adjust the address of the named @var{section}. If @samp{=} is
903used, the section address is set to @var{val}. Otherwise, @var{val} is
904added to or subtracted from the section address. See the comments under
905@samp{--adjust-vma}, above. If @var{section} does not exist in the
906input file, a warning will be issued, unless @samp{--no-adjust-warnings}
907is used.
908
909@item --adjust-warnings
910If @samp{--adjust-section-vma} is used, and the named section does not
911exist, issue a warning. This is the default.
912
913@item --no-adjust-warnings
914Do not issue a warning if @samp{--adjust-section-vma} is used, even if
915the named section does not exist.
916
5ab41086
ILT
917@item --set-section-flags @var{section}=@var{flags}
918Set the flags for the named section. The @var{flags} argument is a
919comma separated string of flag names. The recognized names are
920@samp{alloc}, @samp{load}, @samp{readonly}, @samp{code}, @samp{data},
921and @samp{rom}. Not all flags are meaningful for all object file
922formats.
923
d0130cc8
ILT
924@item --add-section @var{sectionname}=@var{filename}
925Add a new section named @var{sectionname} while copying the file. The
926contents of the new section are taken from the file @var{filename}. The
927size of the section will be the size of the file. This option only
928works on file formats which can support sections with arbitrary names.
929
eed5eeab
DM
930@item -V
931@itemx --version
932Show the version number of @code{objcopy}.
933
934@item -v
935@itemx --verbose
936Verbose output: list all object files modified. In the case of
937archives, @samp{objcopy -V} lists all members of the archive.
938
939@item --help
940Show a summary of the options to @code{objcopy}.
941@end table
942
eae04238 943@node objdump
c72af735
RP
944@chapter objdump
945
946@cindex object file information
947@kindex objdump
948
949@smallexample
10f2a7f6
JO
950objdump [ -a | --archive-headers ]
951 [ -b @var{bfdname} | --target=@var{bfdname} ]
d5464baa
ILT
952 [ -d | --disassemble ] [ -D | --disassemble-all ]
953 [ -f | --file-headers ]
eae04238 954 [ -h | --section-headers | --headers ] [ -i | --info ]
10f2a7f6 955 [ -j @var{section} | --section=@var{section} ]
a8e27cc6 956 [ -l | --line-numbers ] [ -S | --source ]
7e5e9619
JO
957 [ -m @var{machine} | --architecture=@var{machine} ]
958 [ -r | --reloc ] [ -R | --dynamic-reloc ]
959 [ -s | --full-contents ] [ --stabs ]
de3b08ac 960 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
4b6d0f78 961 [ -w | --wide ] [ --version ] [ --help ] @var{objfile}@dots{}
c72af735
RP
962@end smallexample
963
964@code{objdump} displays information about one or more object files.
965The options control what particular information to display. This
966information is mostly useful to programmers who are working on the
967compilation tools, as opposed to programmers who just want their
968program to compile and work.
969
b26ac613
DM
970@var{objfile}@dots{} are the object files to be examined. When you
971specify archives, @code{objdump} shows information on each of the member
972object files.
973
c72af735 974The long and short forms of options, shown here as alternatives, are
ed78872a 975equivalent. At least one option besides @samp{-l} must be given.
c72af735
RP
976
977@table @code
c72af735 978@item -a
eae04238 979@itemx --archive-header
c72af735 980@cindex archive headers
ec40bbb8 981If any of the @var{objfile} files are archives, display the archive
c72af735
RP
982header information (in a format similar to @samp{ls -l}). Besides the
983information you could list with @samp{ar tv}, @samp{objdump -a} shows
984the object file format of each archive member.
985
c72af735 986@item -b @var{bfdname}
eae04238 987@itemx --target=@var{bfdname}
c72af735 988@cindex object code format
ec40bbb8
DM
989Specify that the object-code format for the object files is
990@var{bfdname}. This option may not be necessary; @var{objdump} can
991automatically recognize many formats.
992
993For example,
c72af735
RP
994@example
995objdump -b oasys -m vax -h fu.o
996@end example
997@noindent
ec40bbb8
DM
998displays summary information from the section headers (@samp{-h}) of
999@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
c72af735
RP
1000file in the format produced by Oasys compilers. You can list the
1001formats available with the @samp{-i} option.
eae04238 1002@xref{Target Selection}, for more information.
c72af735
RP
1003
1004@item -d
eae04238 1005@itemx --disassemble
c72af735
RP
1006@cindex disassembling object code
1007@cindex machine instructions
d5464baa
ILT
1008Display the assembler mnemonics for the machine instructions from
1009@var{objfile}. This option only disassembles those sections which are
1010expected to contain instructions.
1011
1012@item -D
1013@itemx --disassemble-all
1014Like @samp{-d}, but disassemble the contents of all sections, not just
1015those expected to contain instructions.
c72af735
RP
1016
1017@item -f
eae04238 1018@itemx --file-header
c72af735 1019@cindex object file header
eae04238 1020Display summary information from the overall header of
ec40bbb8 1021each of the @var{objfile} files.
c72af735
RP
1022
1023@item -h
eae04238 1024@itemx --section-header
c5f0c938 1025@itemx --header
c72af735 1026@cindex section headers
eae04238 1027Display summary information from the section headers of the
c72af735
RP
1028object file.
1029
db2e6adb
DM
1030File segments may be relocated to nonstandard addresses, for example by
1031using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
1032@code{ld}. However, some object file formats, such as a.out, do not
1033store the starting address of the file segments. In those situations,
1034although @code{ld} relocates the sections correctly, using @samp{objdump
1035-h} to list the file section headers cannot show the correct addresses.
1036Instead, it shows the usual addresses, which are implicit for the
1037target.
1038
b26ac613
DM
1039@item --help
1040Print a summary of the options to @code{objdump} and exit.
1041
c72af735 1042@item -i
eae04238 1043@itemx --info
c72af735
RP
1044@cindex architectures available
1045@cindex object formats available
1046Display a list showing all architectures and object formats available
ec40bbb8 1047for specification with @samp{-b} or @samp{-m}.
c72af735 1048
c72af735 1049@item -j @var{name}
eae04238 1050@itemx --section=@var{name}
c72af735 1051@cindex section information
ec40bbb8 1052Display information only for section @var{name}.
c72af735 1053
c72af735 1054@item -l
eae04238 1055@itemx --line-numbers
c72af735 1056@cindex source filenames for object files
eae04238
DM
1057Label the display (using debugging information) with the filename
1058and source line numbers corresponding to the object code shown.
d5464baa 1059Only useful with @samp{-d} or @samp{-D}.
c72af735 1060
c72af735 1061@item -m @var{machine}
eae04238 1062@itemx --architecture=@var{machine}
c72af735 1063@cindex architecture
ec40bbb8 1064Specify that the object files @var{objfile} are for architecture
c72af735
RP
1065@var{machine}. You can list available architectures using the @samp{-i}
1066option.
1067
1068@item -r
c5f0c938 1069@itemx --reloc
c72af735 1070@cindex relocation entries, in object file
d5464baa
ILT
1071Print the relocation entries of the file. If used with @samp{-d} or
1072@samp{-D}, the relocations are printed interspersed with the
1073disassembly.
c72af735 1074
de3b08ac
ILT
1075@item -R
1076@itemx --dynamic-reloc
1077@cindex dynamic relocation entries, in object file
1078Print the dynamic relocation entries of the file. This is only
1079meaningful for dynamic objects, such as certain types of shared
1080libraries.
1081
c72af735 1082@item -s
eae04238 1083@itemx --full-contents
c72af735
RP
1084@cindex sections, full contents
1085@cindex object file sections
1086Display the full contents of any sections requested.
1087
a8e27cc6
ILT
1088@item -S
1089@itemx --source
1090@cindex source disassembly
1091@cindex disassembly, with source
1092Display source code intermixed with disassembly, if possible. Implies
1093@samp{-d}.
1094
c5f0c938
JG
1095@item --stabs
1096@cindex stab
1097@cindex .stab
1098@cindex debug symbols
1099@cindex ELF object file format
c3c93fda
JG
1100Display the full contents of any sections requested. Display the
1101contents of the .stab and .stab.index and .stab.excl sections from an
1102ELF file. This is only useful on systems (such as Solaris 2.0) in which
1103@code{.stab} debugging symbol-table entries are carried in an ELF
1104section. In most other file formats, debugging symbol-table entries are
c5f0c938
JG
1105interleaved with linkage symbols, and are visible in the @samp{--syms}
1106output.
1107
c72af735 1108@item -t
c5f0c938 1109@itemx --syms
c72af735 1110@cindex symbol table entries, printing
eae04238 1111Print the symbol table entries of the file.
c72af735
RP
1112This is similar to the information provided by the @samp{nm} program.
1113
de3b08ac
ILT
1114@item -T
1115@itemx --dynamic-syms
1116@cindex dynamic symbol table entries, printing
1117Print the dynamic symbol table entries of the file. This is only
1118meaningful for dynamic objects, such as certain types of shared
1119libraries. This is similar to the information provided by the @samp{nm}
1120program when given the @samp{-D} (@samp{--dynamic}) option.
1121
b26ac613
DM
1122@item --version
1123Print the version number of @code{objdump} and exit.
1124
c72af735 1125@item -x
eae04238 1126@itemx --all-header
c72af735
RP
1127@cindex all header information, object file
1128@cindex header information, all
1129Display all available header information, including the symbol table and
1130relocation entries. Using @samp{-x} is equivalent to specifying all of
1131@samp{-a -f -h -r -t}.
4b6d0f78
MM
1132
1133@item -w
1134@item --wide
1135@cindex wide output, printing
1136Format some lines for output devices that have more than 80 columns.
c72af735
RP
1137@end table
1138
eae04238 1139@node ranlib
c72af735
RP
1140@chapter ranlib
1141
1142@kindex ranlib
1143@cindex archive contents
1144@cindex symbol index
1145
1146@smallexample
4d9b5d5a 1147ranlib [-vV] @var{archive}
c72af735
RP
1148@end smallexample
1149
ec40bbb8 1150@code{ranlib} generates an index to the contents of an archive and
c72af735
RP
1151stores it in the archive. The index lists each symbol defined by a
1152member of an archive that is a relocatable object file.
1153
918c2f61 1154You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
c72af735 1155
ec40bbb8 1156An archive with such an index speeds up linking to the library and
c72af735
RP
1157allows routines in the library to call each other without regard to
1158their placement in the archive.
1159
1160The GNU @code{ranlib} program is another form of GNU @code{ar}; running
1161@code{ranlib} is completely equivalent to executing @samp{ar -s}.
1162@xref{ar}.
1163
4d9b5d5a
DM
1164@table @code
1165@item -v
1166@itemx -V
1167Show the version number of @code{ranlib}.
c3f471a4 1168@end table
4d9b5d5a 1169
eae04238 1170@node size
c72af735
RP
1171@chapter size
1172
1173@kindex size
1174@cindex section sizes
1175
1176@smallexample
4d9b5d5a
DM
1177size [ -A | -B | --format=@var{compatibility} ]
1178 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1179 [ --target=@var{bfdname} ] [ -V | --version ]
1180 @var{objfile}@dots{}
c72af735
RP
1181@end smallexample
1182
1183The GNU @code{size} utility lists the section sizes---and the total
ec40bbb8
DM
1184size---for each of the object or archive files @var{objfile} in its
1185argument list. By default, one line of output is generated for each
1186object file or each module in an archive.
c72af735 1187
b26ac613
DM
1188@var{objfile}@dots{} are the object files to be examined.
1189
c72af735 1190The command line options have the following meanings:
c72af735 1191
b26ac613 1192@table @code
c72af735
RP
1193@item -A
1194@itemx -B
ec40bbb8 1195@itemx --format=@var{compatibility}
68dd5295 1196@cindex @code{size} display format
c72af735
RP
1197Using one of these options, you can choose whether the output from GNU
1198@code{size} resembles output from System V @code{size} (using @samp{-A},
ec40bbb8
DM
1199or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1200@samp{--format=berkeley}). The default is the one-line format similar to
c72af735 1201Berkeley's.
918c2f61
PB
1202@c Bonus for doc-source readers: you can also say --format=strange (or
1203@c anything else that starts with 's') for sysv, and --format=boring (or
c72af735
RP
1204@c anything else that starts with 'b') for Berkeley.
1205
1206Here is an example of the Berkeley (default) format of output from
1207@code{size}:
1208@smallexample
eae04238 1209size --format=Berkeley ranlib size
c72af735
RP
1210text data bss dec hex filename
1211294880 81920 11592 388392 5ed28 ranlib
1212294880 81920 11888 388688 5ee50 size
1213@end smallexample
1214
1215@noindent
1216This is the same data, but displayed closer to System V conventions:
1217
1218@smallexample
eae04238 1219size --format=SysV ranlib size
c72af735
RP
1220ranlib :
1221section size addr
1222.text 294880 8192
1223.data 81920 303104
1224.bss 11592 385024
1225Total 388392
1226
1227
1228size :
1229section size addr
1230.text 294880 8192
1231.data 81920 303104
1232.bss 11888 385024
1233Total 388688
1234@end smallexample
1235
918c2f61 1236@item --help
c72af735
RP
1237Show a summary of acceptable arguments and options.
1238
1239@item -d
1240@itemx -o
1241@itemx -x
ec40bbb8 1242@itemx --radix=@var{number}
68dd5295 1243@cindex @code{size} number format
c72af735
RP
1244@cindex radix for section sizes
1245Using one of these options, you can control whether the size of each
ec40bbb8
DM
1246section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1247(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1248@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
c72af735
RP
1249values (8, 10, 16) are supported. The total size is always given in two
1250radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1251octal and hexadecimal if you're using @samp{-o}.
1252
ec40bbb8 1253@item --target=@var{bfdname}
c72af735 1254@cindex object code format
ec40bbb8
DM
1255Specify that the object-code format for @var{objfile} is
1256@var{bfdname}. This option may not be necessary; @code{size} can
eae04238
DM
1257automatically recognize many formats.
1258@xref{Target Selection}, for more information.
c72af735
RP
1259
1260@item -V
918c2f61 1261@itemx --version
4d9b5d5a 1262Display the version number of @code{size}.
c72af735
RP
1263@end table
1264
eae04238 1265@node strings
ba7c8e29
DM
1266@chapter strings
1267@kindex strings
1268@cindex listings strings
1269@cindex printing strings
1270@cindex strings, printing
1271
1272@smallexample
b26ac613 1273strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
650a49f0 1274 [--all] [--print-file-name] [--bytes=@var{min-len}]
eae04238
DM
1275 [--radix=@var{radix}] [--target=@var{bfdname}]
1276 [--help] [--version] @var{file}@dots{}
ba7c8e29
DM
1277@end smallexample
1278
1279For each @var{file} given, GNU @code{strings} prints the printable
1280character sequences that are at least 4 characters long (or the number
1281given with the options below) and are followed by a NUL or newline
1282character. By default, it only prints the strings from the initialized
1283data sections of object files; for other types of files, it prints the
1284strings from the whole file.
1285
1286@code{strings} is mainly useful for determining the contents of non-text
1287files.
1288
1289@table @code
1290@item -a
1291@itemx --all
1292@itemx -
1293Do not scan only the initialized data section of object files; scan
1294the whole files.
1295
1296@item -f
1297@itemx --print-file-name
1298Print the name of the file before each string.
1299
b26ac613 1300@item --help
ba7c8e29
DM
1301Print a summary of the program usage on the standard output and exit.
1302
ba7c8e29 1303@itemx -@var{min-len}
b26ac613 1304@item -n @var{min-len}
ba7c8e29
DM
1305@itemx --bytes=@var{min-len}
1306Print sequences of characters that are at least @var{min-len} characters
1307long, instead of the default 4.
1308
1309@item -o
b26ac613
DM
1310Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1311act like @samp{-t d} instead. Since we can not be compatible with both
1312ways, we simply chose one.
ba7c8e29
DM
1313
1314@item -t @var{radix}
1315@itemx --radix=@var{radix}
1316Print the offset within the file before each string. The single
1317character argument specifies the radix of the offset---@samp{o} for
1318octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1319
eae04238
DM
1320@item --target=@var{bfdname}
1321@cindex object code format
1322Specify an object code format other than your system's default format.
1323@xref{Target Selection}, for more information.
1324
ba7c8e29
DM
1325@item -v
1326@itemx --version
1327Print the program version number on the standard output and exit.
1328@end table
1329
eae04238 1330@node strip
c72af735
RP
1331@chapter strip
1332
1333@kindex strip
1334@cindex removing symbols
1335@cindex discarding symbols
1815e42c 1336@cindex symbols, discarding
c72af735
RP
1337
1338@smallexample
eae04238
DM
1339strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1340 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1341 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
b703c078 1342 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
dff604a7 1343 [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
29c0d15c 1344 [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
b703c078 1345 [ -x | --discard-all ] [ -X | --discard-locals ]
0aca460e 1346 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
b26ac613 1347 [ -v | --verbose ] [ -V | --version ] [ --help ]
b703c078 1348 @var{objfile}@dots{}
c72af735
RP
1349@end smallexample
1350
e31e9a8d 1351GNU @code{strip} discards all symbols from object files
ec40bbb8 1352@var{objfile}. The list of object files may include archives.
b26ac613 1353At least one object file must be given.
c72af735 1354
ec40bbb8 1355@code{strip} modifies the files named in its argument,
c72af735 1356rather than writing modified copies under different names.
c72af735 1357
c72af735 1358@table @code
eae04238
DM
1359@item -F @var{bfdname}
1360@itemx --target=@var{bfdname}
b26ac613 1361Treat the original @var{objfile} as a file with the object
eae04238
DM
1362code format @var{bfdname}, and rewrite it in the same format.
1363@xref{Target Selection}, for more information.
b26ac613
DM
1364
1365@item --help
1366Show a summary of the options to @code{strip} and exit.
1367
eae04238
DM
1368@item -I @var{bfdname}
1369@itemx --input-target=@var{bfdname}
ec40bbb8 1370Treat the original @var{objfile} as a file with the object
eae04238
DM
1371code format @var{bfdname}.
1372@xref{Target Selection}, for more information.
918c2f61 1373
eae04238
DM
1374@item -O @var{bfdname}
1375@itemx --output-target=@var{bfdname}
1376Replace @var{objfile} with a file in the output format @var{bfdname}.
1377@xref{Target Selection}, for more information.
918c2f61 1378
0aca460e
ILT
1379@item -R @var{sectionname}
1380@itemx --remove-section=@var{sectionname}
1381Remove any section named @var{sectionname} from the output file. This
1382option may be given more than once. Note that using this option
1383inappropriately may make the output file unusable.
1384
b703c078
DM
1385@item -s
1386@itemx --strip-all
1387Remove all symbols.
1388
918c2f61
PB
1389@item -g
1390@itemx -S
1391@itemx --strip-debug
1392Remove debugging symbols only.
1393
9135e5f8
ILT
1394@item --strip-unneeded
1395Remove all symbols that are not needed for relocation processing.
1396
dff604a7
ILT
1397@item -K @var{symbolname}
1398@itemx --keep-symbol=@var{symbolname}
1399Keep only symbol @var{symbolname} from the source file. This option may
1400be given more than once.
1401
29c0d15c
ILT
1402@item -N @var{symbolname}
1403@itemx --strip-symbol=@var{symbolname}
dff604a7
ILT
1404Remove symbol @var{symbolname} from the source file. This option may be
1405given more than once, and may be combined with strip options other than
1406@code{-K}.
29c0d15c 1407
918c2f61
PB
1408@item -x
1409@itemx --discard-all
1410Remove non-global symbols.
1411
1412@item -X
1413@itemx --discard-locals
1414Remove compiler-generated local symbols.
ec40bbb8 1415(These usually start with @samp{L} or @samp{.}.)
918c2f61
PB
1416
1417@item -V
1418@itemx --version
ec40bbb8 1419Show the version number for @code{strip}.
918c2f61 1420
1815e42c 1421@item -v
918c2f61
PB
1422@itemx --verbose
1423Verbose output: list all object files modified. In the case of
1269d441 1424archives, @samp{strip -v} lists all members of the archive.
c72af735
RP
1425@end table
1426
eae04238 1427@node c++filt
b6216af2
PB
1428@chapter c++filt
1429
1430@kindex c++filt
1431@cindex demangling C++ symbols
1432
b26ac613
DM
1433@smallexample
1434c++filt [ -_ | --strip-underscores ]
6f88f031 1435 [ -n | --no-strip-underscores ]
b26ac613 1436 [ -s @var{format} | --format=@var{format} ]
d6a4c375 1437 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
b26ac613
DM
1438@end smallexample
1439
6c69b6bd
JO
1440The C++ language provides function overloading, which means that you can
1441write many functions with the same name (providing each takes parameters
1442of different types). All C++ function names are encoded into a
b26ac613 1443low-level assembly label (this process is known as
6c69b6bd
JO
1444@dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1445decodes (@dfn{demangles}) low-level names into user-level names so that
1446the linker can keep these overloaded functions from clashing.
1447
1448Every alphanumeric word (consisting of letters, digits, underscores,
1449dollars, or periods) seen in the input is a potential label. If the
1450label decodes into a C++ name, the C++ name replaces the low-level
1451name in the output.
b6216af2 1452
d6a4c375 1453You can use @code{c++filt} to decipher individual symbols:
6c69b6bd
JO
1454
1455@example
1456c++filt @var{symbol}
1457@end example
1458
d6a4c375
DM
1459If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1460names from the standard input and writes the demangled names to the
1461standard output. All results are printed on the standard output.
b6216af2 1462
b26ac613
DM
1463@table @code
1464@item -_
94e9ad77 1465@itemx --strip-underscores
b26ac613
DM
1466On some systems, both the C and C++ compilers put an underscore in front
1467of every name. For example, the C name @code{foo} gets the low-level
6f88f031
ILT
1468name @code{_foo}. This option removes the initial underscore. Whether
1469@code{c++filt} removes the underscore by default is target dependent.
1470
1471@item -n
1472@itemx --no-strip-underscores
1473Do not remove the initial underscore.
b26ac613
DM
1474
1475@item -s @var{format}
1476@itemx --format=@var{format}
1477GNU @code{nm} can decode three different methods of mangling, used by
1478different C++ compilers. The argument to this option selects which
1479method it uses:
1480
1481@table @code
1482@item gnu
1483the one used by the GNU compiler (the default method)
1484@item lucid
1485the one used by the Lucid compiler
1486@item arm
1487the one specified by the C++ Annotated Reference Manual
1488@end table
1489
1490@item --help
1491Print a summary of the options to @code{c++filt} and exit.
1492
1493@item --version
1494Print the version number of @code{c++filt} and exit.
1495@end table
b6216af2 1496
5eac46ae
JO
1497@quotation
1498@emph{Warning:} @code{c++filt} is a new utility, and the details of its
1499user interface are subject to change in future releases. In particular,
1500a command-line option may be required in the the future to decode a name
1501passed as an argument on the command line; in other words,
1502
1503@example
b26ac613 1504c++filt @var{symbol}
5eac46ae
JO
1505@end example
1506
1507@noindent
1508may in a future release become
1509
1510@example
b26ac613 1511c++filt @var{option} @var{symbol}
5eac46ae
JO
1512@end example
1513@end quotation
1514
eae04238 1515@node nlmconv
94e9ad77
JO
1516@chapter nlmconv
1517
1518@code{nlmconv} converts a relocatable object file into a NetWare
8981cac5
JO
1519Loadable Module.
1520
1521@ignore
1522@code{nlmconv} currently works with @samp{i386} object
4961ce5b
JO
1523files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1524object files in @sc{elf}, or @code{a.out} format@footnote{
1525@code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1526format in the Binary File Descriptor library. It has only been tested
1527with the above formats.}.
8981cac5 1528@end ignore
4961ce5b
JO
1529
1530@quotation
1531@emph{Warning:} @code{nlmconv} is not always built as part of the binary
1532utilities, since it is only useful for NLM targets.
1533@end quotation
94e9ad77
JO
1534
1535@smallexample
eae04238
DM
1536nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1537 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
94e9ad77 1538 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
20465f8b 1539 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
94e9ad77
JO
1540 [ -h | --help ] [ -V | --version ]
1541 @var{infile} @var{outfile}
1542@end smallexample
1543
1544@code{nlmconv} converts the relocatable @samp{i386} object file
1545@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1546reading @var{headerfile} for NLM header information. For instructions
5b0ba16d
JO
1547on writing the NLM command file language used in header files, see the
1548@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1549Development and Tools Overview}, which is part of the NLM Software
1550Developer's Kit (``NLM SDK''), available from Novell, Inc.
1551@code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
eae04238 1552@var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
5b0ba16d 1553more information.
94e9ad77 1554
20465f8b
JO
1555@code{nlmconv} can perform a link step. In other words, you can list
1556more than one object file for input if you list them in the definitions
1557file (rather than simply specifying one input file on the command line).
1558In this case, @code{nlmconv} calls the linker for you.
1559
94e9ad77 1560@table @code
eae04238
DM
1561@item -I @var{bfdname}
1562@itemx --input-target=@var{bfdname}
94e9ad77 1563Object format of the input file. @code{nlmconv} can usually determine
eae04238
DM
1564the format of a given file (so no default is necessary).
1565@xref{Target Selection}, for more information.
94e9ad77 1566
eae04238
DM
1567@item -O @var{bfdname}
1568@itemx --output-target=@var{bfdname}
94e9ad77
JO
1569Object format of the output file. @code{nlmconv} infers the output
1570format based on the input format, e.g. for a @samp{i386} input file the
eae04238
DM
1571output format is @samp{nlm32-i386}.
1572@xref{Target Selection}, for more information.
94e9ad77
JO
1573
1574@item -T @var{headerfile}
1575@itemx --header-file=@var{headerfile}
1576Reads @var{headerfile} for NLM header information. For instructions on
5b0ba16d
JO
1577writing the NLM command file language used in header files, see@ see the
1578@samp{linkers} section, of the @cite{NLM Development and Tools
1579Overview}, which is part of the NLM Software Developer's Kit, available
1580from Novell, Inc.
94e9ad77 1581
20465f8b
JO
1582@item -d
1583@itemx --debug
1584Displays (on standard error) the linker command line used by @code{nlmconv}.
1585
1586@item -l @var{linker}
1587@itemx --linker=@var{linker}
1588Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1589relative pathname.
1590
94e9ad77
JO
1591@item -h
1592@itemx --help
1593Prints a usage summary.
1594
1595@item -V
1596@itemx --version
1597Prints the version number for @code{nlmconv}.
1598@end table
1599
eae04238
DM
1600@node Selecting The Target System
1601@chapter Selecting the target system
1602
8981cac5
JO
1603You can specify three aspects of the target system to the @sc{gnu}
1604binary file utilities, each in several ways:
eae04238
DM
1605
1606@itemize @bullet
1607@item
8981cac5 1608the target
eae04238
DM
1609
1610@item
8981cac5 1611the architecture
eae04238
DM
1612
1613@item
8981cac5 1614the linker emulation (which applies to the linker only)
eae04238
DM
1615@end itemize
1616
1617In the following summaries, the lists of ways to specify values are in
8981cac5
JO
1618order of decreasing precedence. The ways listed first override those
1619listed later.
eae04238 1620
8981cac5
JO
1621The commands to list valid values only list the values for which the
1622programs you are running were configured. If they were configured with
eae04238
DM
1623@samp{--with-targets=all}, the commands list most of the available
1624values, but a few are left out; not all targets can be configured in at
8981cac5
JO
1625once because some of them can only be configured @dfn{native} (on hosts
1626with the same type as the target system).
eae04238
DM
1627
1628@menu
1629* Target Selection::
1630* Architecture Selection::
1631* Linker Emulation Selection::
1632@end menu
1633
1634@node Target Selection
8981cac5 1635@section Target Selection
eae04238
DM
1636
1637A @dfn{target} is an object file format. A given target may be
1638supported for multiple architectures (@pxref{Architecture Selection}).
8981cac5
JO
1639A target selection may also have variations for different operating
1640systems or architectures.
eae04238 1641
8981cac5
JO
1642The command to list valid target values is @samp{objdump -i}
1643(the first column of output contains the relevant information).
eae04238 1644
10f2a7f6
JO
1645Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
1646@samp{a.out-sunos-big}.
eae04238 1647
8981cac5 1648@subheading @code{objdump} Target
eae04238
DM
1649
1650Ways to specify:
1651
1652@enumerate
1653@item
8981cac5 1654command line option: @samp{-b} or @samp{--target}
eae04238
DM
1655
1656@item
1657environment variable @code{GNUTARGET}
1658
1659@item
1660deduced from the input file
1661@end enumerate
1662
8981cac5 1663@subheading @code{objcopy} and @code{strip} Input Target
eae04238
DM
1664
1665Ways to specify:
1666
1667@enumerate
1668@item
8981cac5 1669command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1670
1671@item
1672environment variable @code{GNUTARGET}
1673
1674@item
1675deduced from the input file
1676@end enumerate
1677
8981cac5 1678@subheading @code{objcopy} and @code{strip} Output Target
eae04238
DM
1679
1680Ways to specify:
1681
1682@enumerate
1683@item
8981cac5 1684command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1685
1686@item
8981cac5 1687the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
eae04238
DM
1688
1689@item
1690environment variable @code{GNUTARGET}
1691
1692@item
1693deduced from the input file
1694@end enumerate
1695
8981cac5 1696@subheading @code{nm}, @code{size}, and @code{strings} Target
eae04238
DM
1697
1698Ways to specify:
1699
1700@enumerate
1701@item
8981cac5 1702command line option: @samp{--target}
eae04238
DM
1703
1704@item
1705environment variable @code{GNUTARGET}
1706
1707@item
1708deduced from the input file
1709@end enumerate
1710
8981cac5 1711@subheading Linker Input Target
eae04238
DM
1712
1713Ways to specify:
1714
1715@enumerate
1716@item
8981cac5 1717command line option: @samp{-b} or @samp{--format}
eae04238
DM
1718(@pxref{Options,,Options,ld.info,Using LD})
1719
1720@item
1721script command @code{TARGET}
1722(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1723
1724@item
1725environment variable @code{GNUTARGET}
1726(@pxref{Environment,,Environment,ld.info,Using LD})
1727
1728@item
1729the default target of the selected linker emulation
1730(@pxref{Linker Emulation Selection})
1731@end enumerate
1732
8981cac5 1733@subheading Linker Output Target
eae04238
DM
1734
1735Ways to specify:
1736
1737@enumerate
1738@item
8981cac5 1739command line option: @samp{-oformat}
eae04238
DM
1740(@pxref{Options,,Options,ld.info,Using LD})
1741
1742@item
1743script command @code{OUTPUT_FORMAT}
1744(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1745
1746@item
8981cac5 1747the linker input target (see ``Linker Input Target'' above)
eae04238
DM
1748@end enumerate
1749
1750@node Architecture Selection
1751@section Architecture selection
1752
8981cac5
JO
1753An @dfn{architecture} is a type of @sc{cpu} on which an object file is
1754to run. Its name may contain a colon, separating the name of the
1755processor family from the name of the particular @sc{cpu}.
eae04238 1756
8981cac5
JO
1757The command to list valid architecture values is @samp{objdump -i} (the
1758second column contains the relevant information).
eae04238
DM
1759
1760Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
1761
8981cac5 1762@subheading @code{objdump} Architecture
eae04238
DM
1763
1764Ways to specify:
1765
1766@enumerate
1767@item
8981cac5 1768command line option: @samp{-m} or @samp{--architecture}
eae04238
DM
1769
1770@item
1771deduced from the input file
1772@end enumerate
1773
8981cac5 1774@subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
eae04238
DM
1775
1776Ways to specify:
1777
1778@enumerate
1779@item
1780deduced from the input file
1781@end enumerate
1782
8981cac5 1783@subheading Linker Input Architecture
eae04238
DM
1784
1785Ways to specify:
1786
1787@enumerate
1788@item
1789deduced from the input file
1790@end enumerate
1791
8981cac5 1792@subheading Linker Output Architecture
eae04238
DM
1793
1794Ways to specify:
1795
1796@enumerate
1797@item
1798script command @code{OUTPUT_ARCH}
1799(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1800
1801@item
1802the default architecture from the linker output target
8981cac5 1803(@pxref{Target Selection})
eae04238
DM
1804@end enumerate
1805
1806@node Linker Emulation Selection
1807@section Linker emulation selection
1808
1809A linker @dfn{emulation} is a ``personality'' of the linker, which gives
1810the linker default values for the other aspects of the target system.
1811In particular, it consists of
1812
1813@itemize @bullet
1814@item
8981cac5 1815the linker script
eae04238
DM
1816
1817@item
8981cac5 1818the target
eae04238
DM
1819
1820@item
1821several ``hook'' functions that are run at certain stages of the linking
8981cac5 1822process to do special things that some targets require
eae04238
DM
1823@end itemize
1824
8981cac5 1825The command to list valid linker emulation values is @samp{ld -V}.
eae04238
DM
1826
1827Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
1828
1829Ways to specify:
1830
1831@enumerate
1832@item
8981cac5 1833command line option: @samp{-m}
eae04238
DM
1834(@pxref{Options,,Options,ld.info,Using LD})
1835
1836@item
1837environment variable @code{LDEMULATION}
1838
1839@item
1840compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
1841which comes from @code{EMUL} in @file{config/@var{target}.mt}
1842@end enumerate
1843
1844@node Index
c72af735
RP
1845@unnumbered Index
1846
1847@printindex cp
1848
1849@contents
1850@bye
This page took 0.218887 seconds and 4 git commands to generate.