* monitor.[ch], w89k-rom.c, op50n-rom.c, idp-rom.c: Add support
[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
347@item i
348Insert new files @emph{before} an existing member of the
ec40bbb8 349archive. If you use the modifier @samp{i}, 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{b}).
352
353@item l
354This modifier is accepted but not used.
355@c whaffor ar l modifier??? presumably compat; with
356@c what???---pesch@@cygnus.com, 25jan91
357
358@item o
359@cindex dates in archive
360Preserve the @emph{original} dates of members when extracting them. If
361you do not specify this modifier, files extracted from the archive
e31e9a8d 362are stamped with the time of extraction.
c72af735
RP
363
364@item s
365@cindex writing archive index
366Write an object-file index into the archive, or update an existing one,
367even if no other change is made to the archive. You may use this modifier
368flag either with any operation, or alone. Running @samp{ar s} on an
369archive is equivalent to running @samp{ranlib} on it.
370
371@item u
372@cindex updating an archive
b703c078 373Normally, @samp{ar r}@dots{} inserts all files
c72af735
RP
374listed into the archive. If you would like to insert @emph{only} those
375of the files you list that are newer than existing members of the same
376names, use this modifier. The @samp{u} modifier is allowed only for the
377operation @samp{r} (replace). In particular, the combination @samp{qu} is
378not allowed, since checking the timestamps would lose any speed
379advantage from the operation @samp{q}.
380
381@item v
382This modifier requests the @emph{verbose} version of an operation. Many
383operations display additional information, such as filenames processed,
384when the modifier @samp{v} is appended.
4d9b5d5a
DM
385
386@item V
387This modifier shows the version number of @code{ar}.
765a273f
RP
388@end table
389
eae04238 390@node ar scripts
765a273f
RP
391@section Controlling @code{ar} with a script
392
393@smallexample
394ar -M [ <@var{script} ]
395@end smallexample
396
397@cindex MRI compatibility, @code{ar}
398@cindex scripts, @code{ar}
399If you use the single command-line option @samp{-M} with @code{ar}, you
400can control its operation with a rudimentary command language. This
e31e9a8d 401form of @code{ar} operates interactively if standard input is coming
765a273f
RP
402directly from a terminal. During interactive use, @code{ar} prompts for
403input (the prompt is @samp{AR >}), and continues executing even after
404errors. If you redirect standard input to a script file, no prompts are
e31e9a8d 405issued, and @code{ar} abandons execution (with a nonzero exit code)
765a273f
RP
406on any error.
407
408The @code{ar} command language is @emph{not} designed to be equivalent
409to the command-line options; in fact, it provides somewhat less control
410over archives. The only purpose of the command language is to ease the
411transition to GNU @code{ar} for developers who already have scripts
412written for the MRI ``librarian'' program.
413
414The syntax for the @code{ar} command language is straightforward:
415@itemize @bullet
416@item
417commands are recognized in upper or lower case; for example, @code{LIST}
418is the same as @code{list}. In the following descriptions, commands are
419shown in upper case for clarity.
420
421@item
422a single command may appear on each line; it is the first word on the
423line.
424
425@item
426empty lines are allowed, and have no effect.
427
428@item
429comments are allowed; text after either of the characters @samp{*}
430or @samp{;} is ignored.
431
432@item
433Whenever you use a list of names as part of the argument to an @code{ar}
434command, you can separate the individual names with either commas or
435blanks. Commas are shown in the explanations below, for clarity.
436
437@item
438@samp{+} is used as a line continuation character; if @samp{+} appears
439at the end of a line, the text on the following line is considered part
440of the current command.
441@end itemize
442
443Here are the commands you can use in @code{ar} scripts, or when using
444@code{ar} interactively. Three of them have special significance:
445
446@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
447a temporary file required for most of the other commands.
448
449@code{SAVE} commits the changes so far specified by the script. Prior
450to @code{SAVE}, commands affect only the temporary copy of the current
451archive.
452
453@table @code
454@item ADDLIB @var{archive}
455@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})
456Add all the contents of @var{archive} (or, if specified, each named
457@var{module} from @var{archive}) to the current archive.
458
459Requires prior use of @code{OPEN} or @code{CREATE}.
460
650a49f0 461@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}
765a273f
RP
462@c FIXME! w/Replacement?? If so, like "ar r @var{archive} @var{names}"
463@c else like "ar q..."
650a49f0 464Add each named @var{member} as a module in the current archive.
765a273f
RP
465
466Requires prior use of @code{OPEN} or @code{CREATE}.
467
468@item CLEAR
469Discard the contents of the current archive, cancelling the effect of
470any operations since the last @code{SAVE}. May be executed (with no
471effect) even if no current archive is specified.
472
473@item CREATE @var{archive}
474Creates an archive, and makes it the current archive (required for many
475other commands). The new archive is created with a temporary name; it
476is not actually saved as @var{archive} until you use @code{SAVE}.
477You can overwrite existing archives; similarly, the contents of any
478existing file named @var{archive} will not be destroyed until @code{SAVE}.
479
480@item DELETE @var{module}, @var{module}, @dots{} @var{module}
481Delete each listed @var{module} from the current archive; equivalent to
482@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.
483
484Requires prior use of @code{OPEN} or @code{CREATE}.
485
486@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})
487@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}
488List each named @var{module} present in @var{archive}. The separate
489command @code{VERBOSE} specifies the form of the output: when verbose
490output is off, output is like that of @samp{ar -t @var{archive}
b703c078
DM
491@var{module}@dots{}}. When verbose output is on, the listing is like
492@samp{ar -tv @var{archive} @var{module}@dots{}}.
765a273f
RP
493
494Output normally goes to the standard output stream; however, if you
495specify @var{outputfile} as a final argument, @code{ar} directs the
496output to that file.
497
498@item END
499Exit from @code{ar}, with a @code{0} exit code to indicate successful
500completion. This command does not save the output file; if you have
501changed the current archive since the last @code{SAVE} command, those
502changes are lost.
503
504@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}
505Extract each named @var{module} from the current archive, writing them
506into the current directory as separate files. Equivalent to @samp{ar -x
b703c078 507@var{archive} @var{module}@dots{}}.
765a273f
RP
508
509Requires prior use of @code{OPEN} or @code{CREATE}.
510
511@ignore
512@c FIXME Tokens but no commands???
513@item FULLDIR
514
515@item HELP
516@end ignore
517
518@item LIST
519Display full contents of the current archive, in ``verbose'' style
520regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
521tv @var{archive}}). (This single command is a GNU @code{ld}
522enhancement, rather than present for MRI compatibility.)
523
524Requires prior use of @code{OPEN} or @code{CREATE}.
525
526@item OPEN @var{archive}
527Opens an existing archive for use as the current archive (required for
528many other commands). Any changes as the result of subsequent commands
529will not actually affect @var{archive} until you next use @code{SAVE}.
530
531@item REPLACE @var{module}, @var{module}, @dots{} @var{module}
532In the current archive, replace each existing @var{module} (named in
533the @code{REPLACE} arguments) from files in the current working directory.
534To execute this command without errors, both the file, and the module in
535the current archive, must exist.
536
537Requires prior use of @code{OPEN} or @code{CREATE}.
538
539@item VERBOSE
540Toggle an internal flag governing the output from @code{DIRECTORY}.
541When the flag is on, @code{DIRECTORY} output matches output from
b703c078 542@samp{ar -tv }@dots{}.
765a273f
RP
543
544@item SAVE
545Commit your changes to the current archive, and actually save it as a
546file with the name specified in the last @code{CREATE} or @code{OPEN}
547command.
548
549Requires prior use of @code{OPEN} or @code{CREATE}.
c72af735
RP
550
551@end table
552
8b2c2275
RP
553@iftex
554@node ld
c72af735
RP
555@chapter ld
556@cindex linker
557@kindex ld
558The GNU linker @code{ld} is now described in a separate manual.
27e94bd5 559@xref{Top,, Overview,, Using LD: the GNU linker}.
8b2c2275 560@end iftex
c72af735 561
eae04238 562@node nm
c72af735
RP
563@chapter nm
564@cindex symbols
565@kindex nm
566
567@smallexample
d6a4c375 568nm [ -a | --debug-syms ] [ -g | --extern-only ]
de3b08ac 569 [ -B ] [ -C | --demangle ] [ -D | --dynamic ]
1896790e 570 [ -s | --print-armap ] [ -A | -o | --print-file-name ]
6cfbdb50 571 [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
1896790e 572 [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
6cfbdb50
DM
573 [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
574 [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
9eb39bca 575 [ --no-demangle ] [ -V | --version ] [ --help ] [ @var{objfile}@dots{} ]
c72af735
RP
576@end smallexample
577
b703c078 578GNU @code{nm} lists the symbols from object files @var{objfile}@dots{}.
6cfbdb50
DM
579If no object files are listed as arguments, @code{nm} assumes
580@file{a.out}.
581
582For each symbol, @code{nm} shows:
583
584@itemize @bullet
585@item
586The symbol value, in the radix selected by options (see below), or
587hexadecimal by default.
588
589@item
590The symbol type. At least the following types are used; others are, as
591well, depending on the object file format. If lowercase, the symbol is
592local; if uppercase, the symbol is global (external).
593
594@c Some more detail on exactly what these symbol types are used for
595@c would be nice.
596@table @code
597@item A
598Absolute.
599
600@item B
601BSS (uninitialized data).
602
603@item C
604Common.
605
606@item D
607Initialized data.
608
609@item I
610Indirect reference.
611
612@item T
613Text (program code).
614
615@item U
616Undefined.
617@end table
618
619@item
620The symbol name.
621@end itemize
c72af735
RP
622
623The long and short forms of options, shown here as alternatives, are
624equivalent.
625
626@table @code
6cfbdb50
DM
627@item -A
628@itemx -o
629@itemx --print-file-name
630@cindex input file name
631@cindex file name
632@cindex source file name
633Precede each symbol by the name of the input file (or archive element)
634in which it was found, rather than identifying the input file once only,
635before all of its symbols.
c72af735
RP
636
637@item -a
918c2f61 638@itemx --debug-syms
c72af735 639@cindex debugging symbols
6cfbdb50
DM
640Display all symbols, even debugger-only symbols; normally these are not
641listed.
642
68dd5295
DM
643@item -B
644@cindex @code{nm} format
645@cindex @code{nm} compatibility
d6a4c375
DM
646The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
647
648@item -C
649@itemx --demangle
650@cindex demangling C++ symbols
651Decode (@dfn{demangle}) low-level symbol names into user-level names.
652Besides removing any initial underscore prepended by the system, this
653makes C++ function names readable. @xref{c++filt}, for more information
654on demangling.
68dd5295 655
9eb39bca
ILT
656@item --no-demangle
657Do not demangle low-level symbol names. This is the default.
658
de3b08ac
ILT
659@item -D
660@itemx --dynamic
661@cindex dynamic symbols
662Display the dynamic symbols rather than the normal symbols. This is
663only meaningful for dynamic objects, such as certain types of shared
664libraries.
665
6cfbdb50
DM
666@item -f @var{format}
667@itemx --format=@var{format}
68dd5295
DM
668@cindex @code{nm} format
669@cindex @code{nm} compatibility
6cfbdb50
DM
670Use the output format @var{format}, which can be @code{bsd},
671@code{sysv}, or @code{posix}. The default is @code{bsd}.
b26ac613 672Only the first character of @var{format} is significant; it can be
6cfbdb50 673either upper or lower case.
c72af735
RP
674
675@item -g
918c2f61 676@itemx --extern-only
c72af735
RP
677@cindex external symbols
678Display only external symbols.
679
b26ac613
DM
680@item -n
681@itemx -v
682@itemx --numeric-sort
683Sort symbols numerically by their addresses, rather than alphabetically
684by their names.
685
c72af735 686@item -p
918c2f61 687@itemx --no-sort
c72af735 688@cindex sorting symbols
650a49f0 689Do not bother to sort the symbols in any order; print them in the order
6cfbdb50
DM
690encountered.
691
692@item -P
693@itemx --portability
694Use the POSIX.2 standard output format instead of the default format.
695Equivalent to @samp{-f posix}.
c72af735 696
c72af735 697@item -s
918c2f61 698@itemx --print-armap
c72af735
RP
699@cindex symbol index, listing
700When listing symbols from archive members, include the index: a mapping
ec40bbb8
DM
701(stored in the archive by @code{ar} or @code{ranlib}) of which modules
702contain definitions for which names.
c72af735 703
c72af735 704@item -r
918c2f61 705@itemx --reverse-sort
ec40bbb8 706Reverse the order of the sort (whether numeric or alphabetic); let the
c72af735
RP
707last come first.
708
1896790e
ILT
709@item --size-sort
710Sort symbols by size. The size is computed as the difference between
711the value of the symbol and the value of the symbol with the next higher
712value. The size of the symbol is printed, rather than the value.
713
6cfbdb50
DM
714@item -t @var{radix}
715@itemx --radix=@var{radix}
716Use @var{radix} as the radix for printing the symbol values. It must be
717@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.
718
ec40bbb8 719@item --target=@var{bfdname}
c72af735
RP
720@cindex object code format
721Specify an object code format other than your system's default format.
eae04238 722@xref{Target Selection}, for more information.
c72af735
RP
723
724@item -u
918c2f61 725@itemx --undefined-only
c72af735
RP
726@cindex external symbols
727@cindex undefined symbols
728Display only undefined symbols (those external to each object file).
729
6cfbdb50
DM
730@item -V
731@itemx --version
b26ac613
DM
732Show the version number of @code{nm} and exit.
733
734@item --help
735Show a summary of the options to @code{nm} and exit.
c72af735
RP
736@end table
737
eae04238 738@node objcopy
eed5eeab
DM
739@chapter objcopy
740
741@smallexample
eae04238
DM
742objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
743 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
744 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
eed5eeab
DM
745 [ -S | --strip-all ] [ -g | --strip-debug ]
746 [ -x | --discard-all ] [ -X | --discard-locals ]
f7b839f7
DM
747 [ -b @var{byte} | --byte=@var{byte} ]
748 [ -i @var{interleave} | --interleave=@var{interleave} ]
0aca460e 749 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
33e0a06d
ILT
750 [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
751 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
752 [ --adjust-vma=@var{incr} ]
6c7ed084
ILT
753 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
754 [ --adjust-warnings ] [ --no-adjust-warnings ]
f7b839f7 755 [ -v | --verbose ] [ -V | --version ] [ --help ]
eed5eeab
DM
756 @var{infile} [@var{outfile}]
757@end smallexample
758
8981cac5
JO
759The @sc{gnu} @code{objcopy} utility copies the contents of an object
760file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
761read and write the object files. It can write the destination object
762file in a format different from that of the source object file. The
763exact behavior of @code{objcopy} is controlled by command-line options.
eed5eeab
DM
764
765@code{objcopy} creates temporary files to do its translations and
8981cac5
JO
766deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
767translation work; it has access to all the formats described in @sc{bfd}
768and thus is able to recognize most formats without being told
769explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
eed5eeab 770
67f67ed9
ILT
771@code{objcopy} can be used to generate S-records by using an output
772target of @samp{srec} (e.g., use @samp{-O srec}).
773
774@code{objcopy} can be used to generate a raw binary file by using an
775output target of @samp{binary} (e.g., use @samp{-O binary}). When
776@code{objcopy} generates a raw binary file, it will essentially produce
777a memory dump of the contents of the input object file. All symbols and
a6afc090
ILT
778relocation information will be discarded. The memory dump will start at
779the virtual address of the lowest section copied into the output file.
67f67ed9
ILT
780
781When generating an S-record or a raw binary file, it may be helpful to
782use @samp{-S} to remove sections containing debugging information. In
783some cases @samp{-R} will be useful to remove sections which contain
784information which is not needed by the binary file.
785
eed5eeab
DM
786@table @code
787@item @var{infile}
788@itemx @var{outfile}
8981cac5 789The source and output files, respectively.
eed5eeab
DM
790If you do not specify @var{outfile}, @code{objcopy} creates a
791temporary file and destructively renames the result with
8981cac5 792the name of @var{infile}.
eed5eeab 793
eae04238
DM
794@item -I @var{bfdname}
795@itemx --input-target=@var{bfdname}
796Consider the source file's object format to be @var{bfdname}, rather than
797attempting to deduce it. @xref{Target Selection}, for more information.
eed5eeab 798
eae04238
DM
799@item -O @var{bfdname}
800@itemx --output-target=@var{bfdname}
801Write the output file using the object format @var{bfdname}.
802@xref{Target Selection}, for more information.
eed5eeab 803
eae04238
DM
804@item -F @var{bfdname}
805@itemx --target=@var{bfdname}
806Use @var{bfdname} as the object format for both the input and the output
807file; i.e., simply transfer data from source to destination with no
808translation. @xref{Target Selection}, for more information.
eed5eeab 809
0aca460e
ILT
810@item -R @var{sectionname}
811@itemx --remove-section=@var{sectionname}
812Remove any section named @var{sectionname} from the output file. This
813option may be given more than once. Note that using this option
814inappropriately may make the output file unusable.
815
eed5eeab
DM
816@item -S
817@itemx --strip-all
818Do not copy relocation and symbol information from the source file.
819
820@item -g
821@itemx --strip-debug
822Do not copy debugging symbols from the source file.
823
824@item -x
825@itemx --discard-all
826Do not copy non-global symbols from the source file.
827@c FIXME any reason to prefer "non-global" to "local" here?
828
829@item -X
830@itemx --discard-locals
831Do not copy compiler-generated local symbols.
832(These usually start with @samp{L} or @samp{.}.)
833
db2e6adb
DM
834@item -b @var{byte}
835@itemx --byte=@var{byte}
836Keep only every @var{byte}th byte of the input file (header data is not
f7b839f7
DM
837affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
838where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
839option, or the default of 4. This option is useful for creating files
8981cac5 840to program @sc{rom}. It is typically used with an @code{srec} output
f7b839f7
DM
841target.
842
843@item -i @var{interleave}
844@itemx --interleave=@var{interleave}
8981cac5
JO
845Only copy one out of every @var{interleave} bytes. Select which byte to
846copy with the @var{-b} or @samp{--byte} option. The default is 4.
847@code{objcopy} ignores this option if you do not specify either @samp{-b} or
848@samp{--byte}.
db2e6adb 849
596d99ba
ILT
850@item --gap-fill @var{val}
851Fill gaps between sections with @var{val}. This is done by increasing
852the size of the section with the lower address, and filling in the extra
853space created with @var{val}.
854
33e0a06d
ILT
855@item --pad-to @var{address}
856Pad the output file up to the virtual address @var{address}. This is
857done by increasing the size of the last section. The extra space is
858filled in with the value specified by @samp{--gap-fill} (default zero).
859
6c7ed084
ILT
860@item --set-start @var{val}
861Set the address of the new file to @var{val}. Not all object file
a6afc090 862formats support setting the start address.
6c7ed084
ILT
863
864@item --adjust-start @var{incr}
865Adjust the start address by adding @var{incr}. Not all object file
866formats support setting the start address.
867
868@item --adjust-vma @var{incr}
869Adjust the address of all sections, as well as the start address, by
870adding @var{incr}. Some object file formats do not permit section
871addresses to be changed arbitrarily. Note that this does not relocate
872the sections; if the program expects sections to be loaded at a certain
873address, and this option is used to change the sections such that they
874are loaded at a different address, the program may fail.
875
876@item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
877Set or adjust the address of the named @var{section}. If @samp{=} is
878used, the section address is set to @var{val}. Otherwise, @var{val} is
879added to or subtracted from the section address. See the comments under
880@samp{--adjust-vma}, above. If @var{section} does not exist in the
881input file, a warning will be issued, unless @samp{--no-adjust-warnings}
882is used.
883
884@item --adjust-warnings
885If @samp{--adjust-section-vma} is used, and the named section does not
886exist, issue a warning. This is the default.
887
888@item --no-adjust-warnings
889Do not issue a warning if @samp{--adjust-section-vma} is used, even if
890the named section does not exist.
891
eed5eeab
DM
892@item -V
893@itemx --version
894Show the version number of @code{objcopy}.
895
896@item -v
897@itemx --verbose
898Verbose output: list all object files modified. In the case of
899archives, @samp{objcopy -V} lists all members of the archive.
900
901@item --help
902Show a summary of the options to @code{objcopy}.
903@end table
904
eae04238 905@node objdump
c72af735
RP
906@chapter objdump
907
908@cindex object file information
909@kindex objdump
910
911@smallexample
10f2a7f6
JO
912objdump [ -a | --archive-headers ]
913 [ -b @var{bfdname} | --target=@var{bfdname} ]
d5464baa
ILT
914 [ -d | --disassemble ] [ -D | --disassemble-all ]
915 [ -f | --file-headers ]
eae04238 916 [ -h | --section-headers | --headers ] [ -i | --info ]
10f2a7f6
JO
917 [ -j @var{section} | --section=@var{section} ]
918 [ -l | --line-numbers ]
7e5e9619
JO
919 [ -m @var{machine} | --architecture=@var{machine} ]
920 [ -r | --reloc ] [ -R | --dynamic-reloc ]
921 [ -s | --full-contents ] [ --stabs ]
de3b08ac
ILT
922 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
923 [ --version ] [ --help ] @var{objfile}@dots{}
c72af735
RP
924@end smallexample
925
926@code{objdump} displays information about one or more object files.
927The options control what particular information to display. This
928information is mostly useful to programmers who are working on the
929compilation tools, as opposed to programmers who just want their
930program to compile and work.
931
b26ac613
DM
932@var{objfile}@dots{} are the object files to be examined. When you
933specify archives, @code{objdump} shows information on each of the member
934object files.
935
c72af735 936The long and short forms of options, shown here as alternatives, are
ed78872a 937equivalent. At least one option besides @samp{-l} must be given.
c72af735
RP
938
939@table @code
c72af735 940@item -a
eae04238 941@itemx --archive-header
c72af735 942@cindex archive headers
ec40bbb8 943If any of the @var{objfile} files are archives, display the archive
c72af735
RP
944header information (in a format similar to @samp{ls -l}). Besides the
945information you could list with @samp{ar tv}, @samp{objdump -a} shows
946the object file format of each archive member.
947
c72af735 948@item -b @var{bfdname}
eae04238 949@itemx --target=@var{bfdname}
c72af735 950@cindex object code format
ec40bbb8
DM
951Specify that the object-code format for the object files is
952@var{bfdname}. This option may not be necessary; @var{objdump} can
953automatically recognize many formats.
954
955For example,
c72af735
RP
956@example
957objdump -b oasys -m vax -h fu.o
958@end example
959@noindent
ec40bbb8
DM
960displays summary information from the section headers (@samp{-h}) of
961@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
c72af735
RP
962file in the format produced by Oasys compilers. You can list the
963formats available with the @samp{-i} option.
eae04238 964@xref{Target Selection}, for more information.
c72af735
RP
965
966@item -d
eae04238 967@itemx --disassemble
c72af735
RP
968@cindex disassembling object code
969@cindex machine instructions
d5464baa
ILT
970Display the assembler mnemonics for the machine instructions from
971@var{objfile}. This option only disassembles those sections which are
972expected to contain instructions.
973
974@item -D
975@itemx --disassemble-all
976Like @samp{-d}, but disassemble the contents of all sections, not just
977those expected to contain instructions.
c72af735
RP
978
979@item -f
eae04238 980@itemx --file-header
c72af735 981@cindex object file header
eae04238 982Display summary information from the overall header of
ec40bbb8 983each of the @var{objfile} files.
c72af735
RP
984
985@item -h
eae04238 986@itemx --section-header
c5f0c938 987@itemx --header
c72af735 988@cindex section headers
eae04238 989Display summary information from the section headers of the
c72af735
RP
990object file.
991
db2e6adb
DM
992File segments may be relocated to nonstandard addresses, for example by
993using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
994@code{ld}. However, some object file formats, such as a.out, do not
995store the starting address of the file segments. In those situations,
996although @code{ld} relocates the sections correctly, using @samp{objdump
997-h} to list the file section headers cannot show the correct addresses.
998Instead, it shows the usual addresses, which are implicit for the
999target.
1000
b26ac613
DM
1001@item --help
1002Print a summary of the options to @code{objdump} and exit.
1003
c72af735 1004@item -i
eae04238 1005@itemx --info
c72af735
RP
1006@cindex architectures available
1007@cindex object formats available
1008Display a list showing all architectures and object formats available
ec40bbb8 1009for specification with @samp{-b} or @samp{-m}.
c72af735 1010
c72af735 1011@item -j @var{name}
eae04238 1012@itemx --section=@var{name}
c72af735 1013@cindex section information
ec40bbb8 1014Display information only for section @var{name}.
c72af735 1015
c72af735 1016@item -l
eae04238 1017@itemx --line-numbers
c72af735 1018@cindex source filenames for object files
eae04238
DM
1019Label the display (using debugging information) with the filename
1020and source line numbers corresponding to the object code shown.
d5464baa 1021Only useful with @samp{-d} or @samp{-D}.
c72af735 1022
c72af735 1023@item -m @var{machine}
eae04238 1024@itemx --architecture=@var{machine}
c72af735 1025@cindex architecture
ec40bbb8 1026Specify that the object files @var{objfile} are for architecture
c72af735
RP
1027@var{machine}. You can list available architectures using the @samp{-i}
1028option.
1029
1030@item -r
c5f0c938 1031@itemx --reloc
c72af735 1032@cindex relocation entries, in object file
d5464baa
ILT
1033Print the relocation entries of the file. If used with @samp{-d} or
1034@samp{-D}, the relocations are printed interspersed with the
1035disassembly.
c72af735 1036
de3b08ac
ILT
1037@item -R
1038@itemx --dynamic-reloc
1039@cindex dynamic relocation entries, in object file
1040Print the dynamic relocation entries of the file. This is only
1041meaningful for dynamic objects, such as certain types of shared
1042libraries.
1043
c72af735 1044@item -s
eae04238 1045@itemx --full-contents
c72af735
RP
1046@cindex sections, full contents
1047@cindex object file sections
1048Display the full contents of any sections requested.
1049
c5f0c938
JG
1050@item --stabs
1051@cindex stab
1052@cindex .stab
1053@cindex debug symbols
1054@cindex ELF object file format
c3c93fda
JG
1055Display the full contents of any sections requested. Display the
1056contents of the .stab and .stab.index and .stab.excl sections from an
1057ELF file. This is only useful on systems (such as Solaris 2.0) in which
1058@code{.stab} debugging symbol-table entries are carried in an ELF
1059section. In most other file formats, debugging symbol-table entries are
c5f0c938
JG
1060interleaved with linkage symbols, and are visible in the @samp{--syms}
1061output.
1062
c72af735 1063@item -t
c5f0c938 1064@itemx --syms
c72af735 1065@cindex symbol table entries, printing
eae04238 1066Print the symbol table entries of the file.
c72af735
RP
1067This is similar to the information provided by the @samp{nm} program.
1068
de3b08ac
ILT
1069@item -T
1070@itemx --dynamic-syms
1071@cindex dynamic symbol table entries, printing
1072Print the dynamic symbol table entries of the file. This is only
1073meaningful for dynamic objects, such as certain types of shared
1074libraries. This is similar to the information provided by the @samp{nm}
1075program when given the @samp{-D} (@samp{--dynamic}) option.
1076
b26ac613
DM
1077@item --version
1078Print the version number of @code{objdump} and exit.
1079
c72af735 1080@item -x
eae04238 1081@itemx --all-header
c72af735
RP
1082@cindex all header information, object file
1083@cindex header information, all
1084Display all available header information, including the symbol table and
1085relocation entries. Using @samp{-x} is equivalent to specifying all of
1086@samp{-a -f -h -r -t}.
c72af735
RP
1087@end table
1088
eae04238 1089@node ranlib
c72af735
RP
1090@chapter ranlib
1091
1092@kindex ranlib
1093@cindex archive contents
1094@cindex symbol index
1095
1096@smallexample
4d9b5d5a 1097ranlib [-vV] @var{archive}
c72af735
RP
1098@end smallexample
1099
ec40bbb8 1100@code{ranlib} generates an index to the contents of an archive and
c72af735
RP
1101stores it in the archive. The index lists each symbol defined by a
1102member of an archive that is a relocatable object file.
1103
918c2f61 1104You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
c72af735 1105
ec40bbb8 1106An archive with such an index speeds up linking to the library and
c72af735
RP
1107allows routines in the library to call each other without regard to
1108their placement in the archive.
1109
1110The GNU @code{ranlib} program is another form of GNU @code{ar}; running
1111@code{ranlib} is completely equivalent to executing @samp{ar -s}.
1112@xref{ar}.
1113
4d9b5d5a
DM
1114@table @code
1115@item -v
1116@itemx -V
1117Show the version number of @code{ranlib}.
c3f471a4 1118@end table
4d9b5d5a 1119
eae04238 1120@node size
c72af735
RP
1121@chapter size
1122
1123@kindex size
1124@cindex section sizes
1125
1126@smallexample
4d9b5d5a
DM
1127size [ -A | -B | --format=@var{compatibility} ]
1128 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1129 [ --target=@var{bfdname} ] [ -V | --version ]
1130 @var{objfile}@dots{}
c72af735
RP
1131@end smallexample
1132
1133The GNU @code{size} utility lists the section sizes---and the total
ec40bbb8
DM
1134size---for each of the object or archive files @var{objfile} in its
1135argument list. By default, one line of output is generated for each
1136object file or each module in an archive.
c72af735 1137
b26ac613
DM
1138@var{objfile}@dots{} are the object files to be examined.
1139
c72af735 1140The command line options have the following meanings:
c72af735 1141
b26ac613 1142@table @code
c72af735
RP
1143@item -A
1144@itemx -B
ec40bbb8 1145@itemx --format=@var{compatibility}
68dd5295 1146@cindex @code{size} display format
c72af735
RP
1147Using one of these options, you can choose whether the output from GNU
1148@code{size} resembles output from System V @code{size} (using @samp{-A},
ec40bbb8
DM
1149or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1150@samp{--format=berkeley}). The default is the one-line format similar to
c72af735 1151Berkeley's.
918c2f61
PB
1152@c Bonus for doc-source readers: you can also say --format=strange (or
1153@c anything else that starts with 's') for sysv, and --format=boring (or
c72af735
RP
1154@c anything else that starts with 'b') for Berkeley.
1155
1156Here is an example of the Berkeley (default) format of output from
1157@code{size}:
1158@smallexample
eae04238 1159size --format=Berkeley ranlib size
c72af735
RP
1160text data bss dec hex filename
1161294880 81920 11592 388392 5ed28 ranlib
1162294880 81920 11888 388688 5ee50 size
1163@end smallexample
1164
1165@noindent
1166This is the same data, but displayed closer to System V conventions:
1167
1168@smallexample
eae04238 1169size --format=SysV ranlib size
c72af735
RP
1170ranlib :
1171section size addr
1172.text 294880 8192
1173.data 81920 303104
1174.bss 11592 385024
1175Total 388392
1176
1177
1178size :
1179section size addr
1180.text 294880 8192
1181.data 81920 303104
1182.bss 11888 385024
1183Total 388688
1184@end smallexample
1185
918c2f61 1186@item --help
c72af735
RP
1187Show a summary of acceptable arguments and options.
1188
1189@item -d
1190@itemx -o
1191@itemx -x
ec40bbb8 1192@itemx --radix=@var{number}
68dd5295 1193@cindex @code{size} number format
c72af735
RP
1194@cindex radix for section sizes
1195Using one of these options, you can control whether the size of each
ec40bbb8
DM
1196section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1197(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1198@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
c72af735
RP
1199values (8, 10, 16) are supported. The total size is always given in two
1200radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1201octal and hexadecimal if you're using @samp{-o}.
1202
ec40bbb8 1203@item --target=@var{bfdname}
c72af735 1204@cindex object code format
ec40bbb8
DM
1205Specify that the object-code format for @var{objfile} is
1206@var{bfdname}. This option may not be necessary; @code{size} can
eae04238
DM
1207automatically recognize many formats.
1208@xref{Target Selection}, for more information.
c72af735
RP
1209
1210@item -V
918c2f61 1211@itemx --version
4d9b5d5a 1212Display the version number of @code{size}.
c72af735
RP
1213@end table
1214
eae04238 1215@node strings
ba7c8e29
DM
1216@chapter strings
1217@kindex strings
1218@cindex listings strings
1219@cindex printing strings
1220@cindex strings, printing
1221
1222@smallexample
b26ac613 1223strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
650a49f0 1224 [--all] [--print-file-name] [--bytes=@var{min-len}]
eae04238
DM
1225 [--radix=@var{radix}] [--target=@var{bfdname}]
1226 [--help] [--version] @var{file}@dots{}
ba7c8e29
DM
1227@end smallexample
1228
1229For each @var{file} given, GNU @code{strings} prints the printable
1230character sequences that are at least 4 characters long (or the number
1231given with the options below) and are followed by a NUL or newline
1232character. By default, it only prints the strings from the initialized
1233data sections of object files; for other types of files, it prints the
1234strings from the whole file.
1235
1236@code{strings} is mainly useful for determining the contents of non-text
1237files.
1238
1239@table @code
1240@item -a
1241@itemx --all
1242@itemx -
1243Do not scan only the initialized data section of object files; scan
1244the whole files.
1245
1246@item -f
1247@itemx --print-file-name
1248Print the name of the file before each string.
1249
b26ac613 1250@item --help
ba7c8e29
DM
1251Print a summary of the program usage on the standard output and exit.
1252
ba7c8e29 1253@itemx -@var{min-len}
b26ac613 1254@item -n @var{min-len}
ba7c8e29
DM
1255@itemx --bytes=@var{min-len}
1256Print sequences of characters that are at least @var{min-len} characters
1257long, instead of the default 4.
1258
1259@item -o
b26ac613
DM
1260Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1261act like @samp{-t d} instead. Since we can not be compatible with both
1262ways, we simply chose one.
ba7c8e29
DM
1263
1264@item -t @var{radix}
1265@itemx --radix=@var{radix}
1266Print the offset within the file before each string. The single
1267character argument specifies the radix of the offset---@samp{o} for
1268octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1269
eae04238
DM
1270@item --target=@var{bfdname}
1271@cindex object code format
1272Specify an object code format other than your system's default format.
1273@xref{Target Selection}, for more information.
1274
ba7c8e29
DM
1275@item -v
1276@itemx --version
1277Print the program version number on the standard output and exit.
1278@end table
1279
eae04238 1280@node strip
c72af735
RP
1281@chapter strip
1282
1283@kindex strip
1284@cindex removing symbols
1285@cindex discarding symbols
1815e42c 1286@cindex symbols, discarding
c72af735
RP
1287
1288@smallexample
eae04238
DM
1289strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1290 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1291 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
b703c078
DM
1292 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1293 [ -x | --discard-all ] [ -X | --discard-locals ]
0aca460e 1294 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
b26ac613 1295 [ -v | --verbose ] [ -V | --version ] [ --help ]
b703c078 1296 @var{objfile}@dots{}
c72af735
RP
1297@end smallexample
1298
e31e9a8d 1299GNU @code{strip} discards all symbols from object files
ec40bbb8 1300@var{objfile}. The list of object files may include archives.
b26ac613 1301At least one object file must be given.
c72af735 1302
ec40bbb8 1303@code{strip} modifies the files named in its argument,
c72af735 1304rather than writing modified copies under different names.
c72af735 1305
c72af735 1306@table @code
eae04238
DM
1307@item -F @var{bfdname}
1308@itemx --target=@var{bfdname}
b26ac613 1309Treat the original @var{objfile} as a file with the object
eae04238
DM
1310code format @var{bfdname}, and rewrite it in the same format.
1311@xref{Target Selection}, for more information.
b26ac613
DM
1312
1313@item --help
1314Show a summary of the options to @code{strip} and exit.
1315
eae04238
DM
1316@item -I @var{bfdname}
1317@itemx --input-target=@var{bfdname}
ec40bbb8 1318Treat the original @var{objfile} as a file with the object
eae04238
DM
1319code format @var{bfdname}.
1320@xref{Target Selection}, for more information.
918c2f61 1321
eae04238
DM
1322@item -O @var{bfdname}
1323@itemx --output-target=@var{bfdname}
1324Replace @var{objfile} with a file in the output format @var{bfdname}.
1325@xref{Target Selection}, for more information.
918c2f61 1326
0aca460e
ILT
1327@item -R @var{sectionname}
1328@itemx --remove-section=@var{sectionname}
1329Remove any section named @var{sectionname} from the output file. This
1330option may be given more than once. Note that using this option
1331inappropriately may make the output file unusable.
1332
b703c078
DM
1333@item -s
1334@itemx --strip-all
1335Remove all symbols.
1336
918c2f61
PB
1337@item -g
1338@itemx -S
1339@itemx --strip-debug
1340Remove debugging symbols only.
1341
1342@item -x
1343@itemx --discard-all
1344Remove non-global symbols.
1345
1346@item -X
1347@itemx --discard-locals
1348Remove compiler-generated local symbols.
ec40bbb8 1349(These usually start with @samp{L} or @samp{.}.)
918c2f61
PB
1350
1351@item -V
1352@itemx --version
ec40bbb8 1353Show the version number for @code{strip}.
918c2f61 1354
1815e42c 1355@item -v
918c2f61
PB
1356@itemx --verbose
1357Verbose output: list all object files modified. In the case of
1269d441 1358archives, @samp{strip -v} lists all members of the archive.
c72af735
RP
1359@end table
1360
eae04238 1361@node c++filt
b6216af2
PB
1362@chapter c++filt
1363
1364@kindex c++filt
1365@cindex demangling C++ symbols
1366
b26ac613
DM
1367@smallexample
1368c++filt [ -_ | --strip-underscores ]
6f88f031 1369 [ -n | --no-strip-underscores ]
b26ac613 1370 [ -s @var{format} | --format=@var{format} ]
d6a4c375 1371 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
b26ac613
DM
1372@end smallexample
1373
6c69b6bd
JO
1374The C++ language provides function overloading, which means that you can
1375write many functions with the same name (providing each takes parameters
1376of different types). All C++ function names are encoded into a
b26ac613 1377low-level assembly label (this process is known as
6c69b6bd
JO
1378@dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1379decodes (@dfn{demangles}) low-level names into user-level names so that
1380the linker can keep these overloaded functions from clashing.
1381
1382Every alphanumeric word (consisting of letters, digits, underscores,
1383dollars, or periods) seen in the input is a potential label. If the
1384label decodes into a C++ name, the C++ name replaces the low-level
1385name in the output.
b6216af2 1386
d6a4c375 1387You can use @code{c++filt} to decipher individual symbols:
6c69b6bd
JO
1388
1389@example
1390c++filt @var{symbol}
1391@end example
1392
d6a4c375
DM
1393If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1394names from the standard input and writes the demangled names to the
1395standard output. All results are printed on the standard output.
b6216af2 1396
b26ac613
DM
1397@table @code
1398@item -_
94e9ad77 1399@itemx --strip-underscores
b26ac613
DM
1400On some systems, both the C and C++ compilers put an underscore in front
1401of every name. For example, the C name @code{foo} gets the low-level
6f88f031
ILT
1402name @code{_foo}. This option removes the initial underscore. Whether
1403@code{c++filt} removes the underscore by default is target dependent.
1404
1405@item -n
1406@itemx --no-strip-underscores
1407Do not remove the initial underscore.
b26ac613
DM
1408
1409@item -s @var{format}
1410@itemx --format=@var{format}
1411GNU @code{nm} can decode three different methods of mangling, used by
1412different C++ compilers. The argument to this option selects which
1413method it uses:
1414
1415@table @code
1416@item gnu
1417the one used by the GNU compiler (the default method)
1418@item lucid
1419the one used by the Lucid compiler
1420@item arm
1421the one specified by the C++ Annotated Reference Manual
1422@end table
1423
1424@item --help
1425Print a summary of the options to @code{c++filt} and exit.
1426
1427@item --version
1428Print the version number of @code{c++filt} and exit.
1429@end table
b6216af2 1430
5eac46ae
JO
1431@quotation
1432@emph{Warning:} @code{c++filt} is a new utility, and the details of its
1433user interface are subject to change in future releases. In particular,
1434a command-line option may be required in the the future to decode a name
1435passed as an argument on the command line; in other words,
1436
1437@example
b26ac613 1438c++filt @var{symbol}
5eac46ae
JO
1439@end example
1440
1441@noindent
1442may in a future release become
1443
1444@example
b26ac613 1445c++filt @var{option} @var{symbol}
5eac46ae
JO
1446@end example
1447@end quotation
1448
eae04238 1449@node nlmconv
94e9ad77
JO
1450@chapter nlmconv
1451
1452@code{nlmconv} converts a relocatable object file into a NetWare
8981cac5
JO
1453Loadable Module.
1454
1455@ignore
1456@code{nlmconv} currently works with @samp{i386} object
4961ce5b
JO
1457files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1458object files in @sc{elf}, or @code{a.out} format@footnote{
1459@code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1460format in the Binary File Descriptor library. It has only been tested
1461with the above formats.}.
8981cac5 1462@end ignore
4961ce5b
JO
1463
1464@quotation
1465@emph{Warning:} @code{nlmconv} is not always built as part of the binary
1466utilities, since it is only useful for NLM targets.
1467@end quotation
94e9ad77
JO
1468
1469@smallexample
eae04238
DM
1470nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1471 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
94e9ad77 1472 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
20465f8b 1473 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
94e9ad77
JO
1474 [ -h | --help ] [ -V | --version ]
1475 @var{infile} @var{outfile}
1476@end smallexample
1477
1478@code{nlmconv} converts the relocatable @samp{i386} object file
1479@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1480reading @var{headerfile} for NLM header information. For instructions
5b0ba16d
JO
1481on writing the NLM command file language used in header files, see the
1482@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1483Development and Tools Overview}, which is part of the NLM Software
1484Developer's Kit (``NLM SDK''), available from Novell, Inc.
1485@code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
eae04238 1486@var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
5b0ba16d 1487more information.
94e9ad77 1488
20465f8b
JO
1489@code{nlmconv} can perform a link step. In other words, you can list
1490more than one object file for input if you list them in the definitions
1491file (rather than simply specifying one input file on the command line).
1492In this case, @code{nlmconv} calls the linker for you.
1493
94e9ad77 1494@table @code
eae04238
DM
1495@item -I @var{bfdname}
1496@itemx --input-target=@var{bfdname}
94e9ad77 1497Object format of the input file. @code{nlmconv} can usually determine
eae04238
DM
1498the format of a given file (so no default is necessary).
1499@xref{Target Selection}, for more information.
94e9ad77 1500
eae04238
DM
1501@item -O @var{bfdname}
1502@itemx --output-target=@var{bfdname}
94e9ad77
JO
1503Object format of the output file. @code{nlmconv} infers the output
1504format based on the input format, e.g. for a @samp{i386} input file the
eae04238
DM
1505output format is @samp{nlm32-i386}.
1506@xref{Target Selection}, for more information.
94e9ad77
JO
1507
1508@item -T @var{headerfile}
1509@itemx --header-file=@var{headerfile}
1510Reads @var{headerfile} for NLM header information. For instructions on
5b0ba16d
JO
1511writing the NLM command file language used in header files, see@ see the
1512@samp{linkers} section, of the @cite{NLM Development and Tools
1513Overview}, which is part of the NLM Software Developer's Kit, available
1514from Novell, Inc.
94e9ad77 1515
20465f8b
JO
1516@item -d
1517@itemx --debug
1518Displays (on standard error) the linker command line used by @code{nlmconv}.
1519
1520@item -l @var{linker}
1521@itemx --linker=@var{linker}
1522Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1523relative pathname.
1524
94e9ad77
JO
1525@item -h
1526@itemx --help
1527Prints a usage summary.
1528
1529@item -V
1530@itemx --version
1531Prints the version number for @code{nlmconv}.
1532@end table
1533
eae04238
DM
1534@node Selecting The Target System
1535@chapter Selecting the target system
1536
8981cac5
JO
1537You can specify three aspects of the target system to the @sc{gnu}
1538binary file utilities, each in several ways:
eae04238
DM
1539
1540@itemize @bullet
1541@item
8981cac5 1542the target
eae04238
DM
1543
1544@item
8981cac5 1545the architecture
eae04238
DM
1546
1547@item
8981cac5 1548the linker emulation (which applies to the linker only)
eae04238
DM
1549@end itemize
1550
1551In the following summaries, the lists of ways to specify values are in
8981cac5
JO
1552order of decreasing precedence. The ways listed first override those
1553listed later.
eae04238 1554
8981cac5
JO
1555The commands to list valid values only list the values for which the
1556programs you are running were configured. If they were configured with
eae04238
DM
1557@samp{--with-targets=all}, the commands list most of the available
1558values, but a few are left out; not all targets can be configured in at
8981cac5
JO
1559once because some of them can only be configured @dfn{native} (on hosts
1560with the same type as the target system).
eae04238
DM
1561
1562@menu
1563* Target Selection::
1564* Architecture Selection::
1565* Linker Emulation Selection::
1566@end menu
1567
1568@node Target Selection
8981cac5 1569@section Target Selection
eae04238
DM
1570
1571A @dfn{target} is an object file format. A given target may be
1572supported for multiple architectures (@pxref{Architecture Selection}).
8981cac5
JO
1573A target selection may also have variations for different operating
1574systems or architectures.
eae04238 1575
8981cac5
JO
1576The command to list valid target values is @samp{objdump -i}
1577(the first column of output contains the relevant information).
eae04238 1578
10f2a7f6
JO
1579Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
1580@samp{a.out-sunos-big}.
eae04238 1581
8981cac5 1582@subheading @code{objdump} Target
eae04238
DM
1583
1584Ways to specify:
1585
1586@enumerate
1587@item
8981cac5 1588command line option: @samp{-b} or @samp{--target}
eae04238
DM
1589
1590@item
1591environment variable @code{GNUTARGET}
1592
1593@item
1594deduced from the input file
1595@end enumerate
1596
8981cac5 1597@subheading @code{objcopy} and @code{strip} Input Target
eae04238
DM
1598
1599Ways to specify:
1600
1601@enumerate
1602@item
8981cac5 1603command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1604
1605@item
1606environment variable @code{GNUTARGET}
1607
1608@item
1609deduced from the input file
1610@end enumerate
1611
8981cac5 1612@subheading @code{objcopy} and @code{strip} Output Target
eae04238
DM
1613
1614Ways to specify:
1615
1616@enumerate
1617@item
8981cac5 1618command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1619
1620@item
8981cac5 1621the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
eae04238
DM
1622
1623@item
1624environment variable @code{GNUTARGET}
1625
1626@item
1627deduced from the input file
1628@end enumerate
1629
8981cac5 1630@subheading @code{nm}, @code{size}, and @code{strings} Target
eae04238
DM
1631
1632Ways to specify:
1633
1634@enumerate
1635@item
8981cac5 1636command line option: @samp{--target}
eae04238
DM
1637
1638@item
1639environment variable @code{GNUTARGET}
1640
1641@item
1642deduced from the input file
1643@end enumerate
1644
8981cac5 1645@subheading Linker Input Target
eae04238
DM
1646
1647Ways to specify:
1648
1649@enumerate
1650@item
8981cac5 1651command line option: @samp{-b} or @samp{--format}
eae04238
DM
1652(@pxref{Options,,Options,ld.info,Using LD})
1653
1654@item
1655script command @code{TARGET}
1656(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1657
1658@item
1659environment variable @code{GNUTARGET}
1660(@pxref{Environment,,Environment,ld.info,Using LD})
1661
1662@item
1663the default target of the selected linker emulation
1664(@pxref{Linker Emulation Selection})
1665@end enumerate
1666
8981cac5 1667@subheading Linker Output Target
eae04238
DM
1668
1669Ways to specify:
1670
1671@enumerate
1672@item
8981cac5 1673command line option: @samp{-oformat}
eae04238
DM
1674(@pxref{Options,,Options,ld.info,Using LD})
1675
1676@item
1677script command @code{OUTPUT_FORMAT}
1678(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1679
1680@item
8981cac5 1681the linker input target (see ``Linker Input Target'' above)
eae04238
DM
1682@end enumerate
1683
1684@node Architecture Selection
1685@section Architecture selection
1686
8981cac5
JO
1687An @dfn{architecture} is a type of @sc{cpu} on which an object file is
1688to run. Its name may contain a colon, separating the name of the
1689processor family from the name of the particular @sc{cpu}.
eae04238 1690
8981cac5
JO
1691The command to list valid architecture values is @samp{objdump -i} (the
1692second column contains the relevant information).
eae04238
DM
1693
1694Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
1695
8981cac5 1696@subheading @code{objdump} Architecture
eae04238
DM
1697
1698Ways to specify:
1699
1700@enumerate
1701@item
8981cac5 1702command line option: @samp{-m} or @samp{--architecture}
eae04238
DM
1703
1704@item
1705deduced from the input file
1706@end enumerate
1707
8981cac5 1708@subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
eae04238
DM
1709
1710Ways to specify:
1711
1712@enumerate
1713@item
1714deduced from the input file
1715@end enumerate
1716
8981cac5 1717@subheading Linker Input Architecture
eae04238
DM
1718
1719Ways to specify:
1720
1721@enumerate
1722@item
1723deduced from the input file
1724@end enumerate
1725
8981cac5 1726@subheading Linker Output Architecture
eae04238
DM
1727
1728Ways to specify:
1729
1730@enumerate
1731@item
1732script command @code{OUTPUT_ARCH}
1733(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1734
1735@item
1736the default architecture from the linker output target
8981cac5 1737(@pxref{Target Selection})
eae04238
DM
1738@end enumerate
1739
1740@node Linker Emulation Selection
1741@section Linker emulation selection
1742
1743A linker @dfn{emulation} is a ``personality'' of the linker, which gives
1744the linker default values for the other aspects of the target system.
1745In particular, it consists of
1746
1747@itemize @bullet
1748@item
8981cac5 1749the linker script
eae04238
DM
1750
1751@item
8981cac5 1752the target
eae04238
DM
1753
1754@item
1755several ``hook'' functions that are run at certain stages of the linking
8981cac5 1756process to do special things that some targets require
eae04238
DM
1757@end itemize
1758
8981cac5 1759The command to list valid linker emulation values is @samp{ld -V}.
eae04238
DM
1760
1761Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
1762
1763Ways to specify:
1764
1765@enumerate
1766@item
8981cac5 1767command line option: @samp{-m}
eae04238
DM
1768(@pxref{Options,,Options,ld.info,Using LD})
1769
1770@item
1771environment variable @code{LDEMULATION}
1772
1773@item
1774compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
1775which comes from @code{EMUL} in @file{config/@var{target}.mt}
1776@end enumerate
1777
1778@node Index
c72af735
RP
1779@unnumbered Index
1780
1781@printindex cp
1782
1783@contents
1784@bye
This page took 0.226661 seconds and 4 git commands to generate.