* binary.c: New file for raw binary output format.
[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} ]
6c7ed084
ILT
750 [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
751 [ --adjust-vma=@var{incr} ]
752 [ --adjust-section-vma=@var{section}@{=,+,-@}@var{val} ]
753 [ --adjust-warnings ] [ --no-adjust-warnings ]
f7b839f7 754 [ -v | --verbose ] [ -V | --version ] [ --help ]
eed5eeab
DM
755 @var{infile} [@var{outfile}]
756@end smallexample
757
8981cac5
JO
758The @sc{gnu} @code{objcopy} utility copies the contents of an object
759file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
760read and write the object files. It can write the destination object
761file in a format different from that of the source object file. The
762exact behavior of @code{objcopy} is controlled by command-line options.
eed5eeab
DM
763
764@code{objcopy} creates temporary files to do its translations and
8981cac5
JO
765deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
766translation work; it has access to all the formats described in @sc{bfd}
767and thus is able to recognize most formats without being told
768explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
eed5eeab
DM
769
770@table @code
771@item @var{infile}
772@itemx @var{outfile}
8981cac5 773The source and output files, respectively.
eed5eeab
DM
774If you do not specify @var{outfile}, @code{objcopy} creates a
775temporary file and destructively renames the result with
8981cac5 776the name of @var{infile}.
eed5eeab 777
eae04238
DM
778@item -I @var{bfdname}
779@itemx --input-target=@var{bfdname}
780Consider the source file's object format to be @var{bfdname}, rather than
781attempting to deduce it. @xref{Target Selection}, for more information.
eed5eeab 782
eae04238
DM
783@item -O @var{bfdname}
784@itemx --output-target=@var{bfdname}
785Write the output file using the object format @var{bfdname}.
786@xref{Target Selection}, for more information.
eed5eeab 787
eae04238
DM
788@item -F @var{bfdname}
789@itemx --target=@var{bfdname}
790Use @var{bfdname} as the object format for both the input and the output
791file; i.e., simply transfer data from source to destination with no
792translation. @xref{Target Selection}, for more information.
eed5eeab 793
0aca460e
ILT
794@item -R @var{sectionname}
795@itemx --remove-section=@var{sectionname}
796Remove any section named @var{sectionname} from the output file. This
797option may be given more than once. Note that using this option
798inappropriately may make the output file unusable.
799
eed5eeab
DM
800@item -S
801@itemx --strip-all
802Do not copy relocation and symbol information from the source file.
803
804@item -g
805@itemx --strip-debug
806Do not copy debugging symbols from the source file.
807
808@item -x
809@itemx --discard-all
810Do not copy non-global symbols from the source file.
811@c FIXME any reason to prefer "non-global" to "local" here?
812
813@item -X
814@itemx --discard-locals
815Do not copy compiler-generated local symbols.
816(These usually start with @samp{L} or @samp{.}.)
817
db2e6adb
DM
818@item -b @var{byte}
819@itemx --byte=@var{byte}
820Keep only every @var{byte}th byte of the input file (header data is not
f7b839f7
DM
821affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
822where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
823option, or the default of 4. This option is useful for creating files
8981cac5 824to program @sc{rom}. It is typically used with an @code{srec} output
f7b839f7
DM
825target.
826
827@item -i @var{interleave}
828@itemx --interleave=@var{interleave}
8981cac5
JO
829Only copy one out of every @var{interleave} bytes. Select which byte to
830copy with the @var{-b} or @samp{--byte} option. The default is 4.
831@code{objcopy} ignores this option if you do not specify either @samp{-b} or
832@samp{--byte}.
db2e6adb 833
6c7ed084
ILT
834@item --set-start @var{val}
835Set the address of the new file to @var{val}. Not all object file
836formats support setting the start address.
837
838@item --adjust-start @var{incr}
839Adjust the start address by adding @var{incr}. Not all object file
840formats support setting the start address.
841
842@item --adjust-vma @var{incr}
843Adjust the address of all sections, as well as the start address, by
844adding @var{incr}. Some object file formats do not permit section
845addresses to be changed arbitrarily. Note that this does not relocate
846the sections; if the program expects sections to be loaded at a certain
847address, and this option is used to change the sections such that they
848are loaded at a different address, the program may fail.
849
850@item --adjust-section-vma @var{section}@{=,+,-@}@var{val}
851Set or adjust the address of the named @var{section}. If @samp{=} is
852used, the section address is set to @var{val}. Otherwise, @var{val} is
853added to or subtracted from the section address. See the comments under
854@samp{--adjust-vma}, above. If @var{section} does not exist in the
855input file, a warning will be issued, unless @samp{--no-adjust-warnings}
856is used.
857
858@item --adjust-warnings
859If @samp{--adjust-section-vma} is used, and the named section does not
860exist, issue a warning. This is the default.
861
862@item --no-adjust-warnings
863Do not issue a warning if @samp{--adjust-section-vma} is used, even if
864the named section does not exist.
865
eed5eeab
DM
866@item -V
867@itemx --version
868Show the version number of @code{objcopy}.
869
870@item -v
871@itemx --verbose
872Verbose output: list all object files modified. In the case of
873archives, @samp{objcopy -V} lists all members of the archive.
874
875@item --help
876Show a summary of the options to @code{objcopy}.
877@end table
878
eae04238 879@node objdump
c72af735
RP
880@chapter objdump
881
882@cindex object file information
883@kindex objdump
884
885@smallexample
10f2a7f6
JO
886objdump [ -a | --archive-headers ]
887 [ -b @var{bfdname} | --target=@var{bfdname} ]
d5464baa
ILT
888 [ -d | --disassemble ] [ -D | --disassemble-all ]
889 [ -f | --file-headers ]
eae04238 890 [ -h | --section-headers | --headers ] [ -i | --info ]
10f2a7f6
JO
891 [ -j @var{section} | --section=@var{section} ]
892 [ -l | --line-numbers ]
7e5e9619
JO
893 [ -m @var{machine} | --architecture=@var{machine} ]
894 [ -r | --reloc ] [ -R | --dynamic-reloc ]
895 [ -s | --full-contents ] [ --stabs ]
de3b08ac
ILT
896 [ -t | --syms ] [ -T | --dynamic-syms ] [ -x | --all-headers ]
897 [ --version ] [ --help ] @var{objfile}@dots{}
c72af735
RP
898@end smallexample
899
900@code{objdump} displays information about one or more object files.
901The options control what particular information to display. This
902information is mostly useful to programmers who are working on the
903compilation tools, as opposed to programmers who just want their
904program to compile and work.
905
b26ac613
DM
906@var{objfile}@dots{} are the object files to be examined. When you
907specify archives, @code{objdump} shows information on each of the member
908object files.
909
c72af735 910The long and short forms of options, shown here as alternatives, are
ed78872a 911equivalent. At least one option besides @samp{-l} must be given.
c72af735
RP
912
913@table @code
c72af735 914@item -a
eae04238 915@itemx --archive-header
c72af735 916@cindex archive headers
ec40bbb8 917If any of the @var{objfile} files are archives, display the archive
c72af735
RP
918header information (in a format similar to @samp{ls -l}). Besides the
919information you could list with @samp{ar tv}, @samp{objdump -a} shows
920the object file format of each archive member.
921
c72af735 922@item -b @var{bfdname}
eae04238 923@itemx --target=@var{bfdname}
c72af735 924@cindex object code format
ec40bbb8
DM
925Specify that the object-code format for the object files is
926@var{bfdname}. This option may not be necessary; @var{objdump} can
927automatically recognize many formats.
928
929For example,
c72af735
RP
930@example
931objdump -b oasys -m vax -h fu.o
932@end example
933@noindent
ec40bbb8
DM
934displays summary information from the section headers (@samp{-h}) of
935@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
c72af735
RP
936file in the format produced by Oasys compilers. You can list the
937formats available with the @samp{-i} option.
eae04238 938@xref{Target Selection}, for more information.
c72af735
RP
939
940@item -d
eae04238 941@itemx --disassemble
c72af735
RP
942@cindex disassembling object code
943@cindex machine instructions
d5464baa
ILT
944Display the assembler mnemonics for the machine instructions from
945@var{objfile}. This option only disassembles those sections which are
946expected to contain instructions.
947
948@item -D
949@itemx --disassemble-all
950Like @samp{-d}, but disassemble the contents of all sections, not just
951those expected to contain instructions.
c72af735
RP
952
953@item -f
eae04238 954@itemx --file-header
c72af735 955@cindex object file header
eae04238 956Display summary information from the overall header of
ec40bbb8 957each of the @var{objfile} files.
c72af735
RP
958
959@item -h
eae04238 960@itemx --section-header
c5f0c938 961@itemx --header
c72af735 962@cindex section headers
eae04238 963Display summary information from the section headers of the
c72af735
RP
964object file.
965
db2e6adb
DM
966File segments may be relocated to nonstandard addresses, for example by
967using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
968@code{ld}. However, some object file formats, such as a.out, do not
969store the starting address of the file segments. In those situations,
970although @code{ld} relocates the sections correctly, using @samp{objdump
971-h} to list the file section headers cannot show the correct addresses.
972Instead, it shows the usual addresses, which are implicit for the
973target.
974
b26ac613
DM
975@item --help
976Print a summary of the options to @code{objdump} and exit.
977
c72af735 978@item -i
eae04238 979@itemx --info
c72af735
RP
980@cindex architectures available
981@cindex object formats available
982Display a list showing all architectures and object formats available
ec40bbb8 983for specification with @samp{-b} or @samp{-m}.
c72af735 984
c72af735 985@item -j @var{name}
eae04238 986@itemx --section=@var{name}
c72af735 987@cindex section information
ec40bbb8 988Display information only for section @var{name}.
c72af735 989
c72af735 990@item -l
eae04238 991@itemx --line-numbers
c72af735 992@cindex source filenames for object files
eae04238
DM
993Label the display (using debugging information) with the filename
994and source line numbers corresponding to the object code shown.
d5464baa 995Only useful with @samp{-d} or @samp{-D}.
c72af735 996
c72af735 997@item -m @var{machine}
eae04238 998@itemx --architecture=@var{machine}
c72af735 999@cindex architecture
ec40bbb8 1000Specify that the object files @var{objfile} are for architecture
c72af735
RP
1001@var{machine}. You can list available architectures using the @samp{-i}
1002option.
1003
1004@item -r
c5f0c938 1005@itemx --reloc
c72af735 1006@cindex relocation entries, in object file
d5464baa
ILT
1007Print the relocation entries of the file. If used with @samp{-d} or
1008@samp{-D}, the relocations are printed interspersed with the
1009disassembly.
c72af735 1010
de3b08ac
ILT
1011@item -R
1012@itemx --dynamic-reloc
1013@cindex dynamic relocation entries, in object file
1014Print the dynamic relocation entries of the file. This is only
1015meaningful for dynamic objects, such as certain types of shared
1016libraries.
1017
c72af735 1018@item -s
eae04238 1019@itemx --full-contents
c72af735
RP
1020@cindex sections, full contents
1021@cindex object file sections
1022Display the full contents of any sections requested.
1023
c5f0c938
JG
1024@item --stabs
1025@cindex stab
1026@cindex .stab
1027@cindex debug symbols
1028@cindex ELF object file format
c3c93fda
JG
1029Display the full contents of any sections requested. Display the
1030contents of the .stab and .stab.index and .stab.excl sections from an
1031ELF file. This is only useful on systems (such as Solaris 2.0) in which
1032@code{.stab} debugging symbol-table entries are carried in an ELF
1033section. In most other file formats, debugging symbol-table entries are
c5f0c938
JG
1034interleaved with linkage symbols, and are visible in the @samp{--syms}
1035output.
1036
c72af735 1037@item -t
c5f0c938 1038@itemx --syms
c72af735 1039@cindex symbol table entries, printing
eae04238 1040Print the symbol table entries of the file.
c72af735
RP
1041This is similar to the information provided by the @samp{nm} program.
1042
de3b08ac
ILT
1043@item -T
1044@itemx --dynamic-syms
1045@cindex dynamic symbol table entries, printing
1046Print the dynamic symbol table entries of the file. This is only
1047meaningful for dynamic objects, such as certain types of shared
1048libraries. This is similar to the information provided by the @samp{nm}
1049program when given the @samp{-D} (@samp{--dynamic}) option.
1050
b26ac613
DM
1051@item --version
1052Print the version number of @code{objdump} and exit.
1053
c72af735 1054@item -x
eae04238 1055@itemx --all-header
c72af735
RP
1056@cindex all header information, object file
1057@cindex header information, all
1058Display all available header information, including the symbol table and
1059relocation entries. Using @samp{-x} is equivalent to specifying all of
1060@samp{-a -f -h -r -t}.
c72af735
RP
1061@end table
1062
eae04238 1063@node ranlib
c72af735
RP
1064@chapter ranlib
1065
1066@kindex ranlib
1067@cindex archive contents
1068@cindex symbol index
1069
1070@smallexample
4d9b5d5a 1071ranlib [-vV] @var{archive}
c72af735
RP
1072@end smallexample
1073
ec40bbb8 1074@code{ranlib} generates an index to the contents of an archive and
c72af735
RP
1075stores it in the archive. The index lists each symbol defined by a
1076member of an archive that is a relocatable object file.
1077
918c2f61 1078You may use @samp{nm -s} or @samp{nm --print-armap} to list this index.
c72af735 1079
ec40bbb8 1080An archive with such an index speeds up linking to the library and
c72af735
RP
1081allows routines in the library to call each other without regard to
1082their placement in the archive.
1083
1084The GNU @code{ranlib} program is another form of GNU @code{ar}; running
1085@code{ranlib} is completely equivalent to executing @samp{ar -s}.
1086@xref{ar}.
1087
4d9b5d5a
DM
1088@table @code
1089@item -v
1090@itemx -V
1091Show the version number of @code{ranlib}.
c3f471a4 1092@end table
4d9b5d5a 1093
eae04238 1094@node size
c72af735
RP
1095@chapter size
1096
1097@kindex size
1098@cindex section sizes
1099
1100@smallexample
4d9b5d5a
DM
1101size [ -A | -B | --format=@var{compatibility} ]
1102 [ --help ] [ -d | -o | -x | --radix=@var{number} ]
1103 [ --target=@var{bfdname} ] [ -V | --version ]
1104 @var{objfile}@dots{}
c72af735
RP
1105@end smallexample
1106
1107The GNU @code{size} utility lists the section sizes---and the total
ec40bbb8
DM
1108size---for each of the object or archive files @var{objfile} in its
1109argument list. By default, one line of output is generated for each
1110object file or each module in an archive.
c72af735 1111
b26ac613
DM
1112@var{objfile}@dots{} are the object files to be examined.
1113
c72af735 1114The command line options have the following meanings:
c72af735 1115
b26ac613 1116@table @code
c72af735
RP
1117@item -A
1118@itemx -B
ec40bbb8 1119@itemx --format=@var{compatibility}
68dd5295 1120@cindex @code{size} display format
c72af735
RP
1121Using one of these options, you can choose whether the output from GNU
1122@code{size} resembles output from System V @code{size} (using @samp{-A},
ec40bbb8
DM
1123or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
1124@samp{--format=berkeley}). The default is the one-line format similar to
c72af735 1125Berkeley's.
918c2f61
PB
1126@c Bonus for doc-source readers: you can also say --format=strange (or
1127@c anything else that starts with 's') for sysv, and --format=boring (or
c72af735
RP
1128@c anything else that starts with 'b') for Berkeley.
1129
1130Here is an example of the Berkeley (default) format of output from
1131@code{size}:
1132@smallexample
eae04238 1133size --format=Berkeley ranlib size
c72af735
RP
1134text data bss dec hex filename
1135294880 81920 11592 388392 5ed28 ranlib
1136294880 81920 11888 388688 5ee50 size
1137@end smallexample
1138
1139@noindent
1140This is the same data, but displayed closer to System V conventions:
1141
1142@smallexample
eae04238 1143size --format=SysV ranlib size
c72af735
RP
1144ranlib :
1145section size addr
1146.text 294880 8192
1147.data 81920 303104
1148.bss 11592 385024
1149Total 388392
1150
1151
1152size :
1153section size addr
1154.text 294880 8192
1155.data 81920 303104
1156.bss 11888 385024
1157Total 388688
1158@end smallexample
1159
918c2f61 1160@item --help
c72af735
RP
1161Show a summary of acceptable arguments and options.
1162
1163@item -d
1164@itemx -o
1165@itemx -x
ec40bbb8 1166@itemx --radix=@var{number}
68dd5295 1167@cindex @code{size} number format
c72af735
RP
1168@cindex radix for section sizes
1169Using one of these options, you can control whether the size of each
ec40bbb8
DM
1170section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
1171(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
1172@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
c72af735
RP
1173values (8, 10, 16) are supported. The total size is always given in two
1174radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
1175octal and hexadecimal if you're using @samp{-o}.
1176
ec40bbb8 1177@item --target=@var{bfdname}
c72af735 1178@cindex object code format
ec40bbb8
DM
1179Specify that the object-code format for @var{objfile} is
1180@var{bfdname}. This option may not be necessary; @code{size} can
eae04238
DM
1181automatically recognize many formats.
1182@xref{Target Selection}, for more information.
c72af735
RP
1183
1184@item -V
918c2f61 1185@itemx --version
4d9b5d5a 1186Display the version number of @code{size}.
c72af735
RP
1187@end table
1188
eae04238 1189@node strings
ba7c8e29
DM
1190@chapter strings
1191@kindex strings
1192@cindex listings strings
1193@cindex printing strings
1194@cindex strings, printing
1195
1196@smallexample
b26ac613 1197strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
650a49f0 1198 [--all] [--print-file-name] [--bytes=@var{min-len}]
eae04238
DM
1199 [--radix=@var{radix}] [--target=@var{bfdname}]
1200 [--help] [--version] @var{file}@dots{}
ba7c8e29
DM
1201@end smallexample
1202
1203For each @var{file} given, GNU @code{strings} prints the printable
1204character sequences that are at least 4 characters long (or the number
1205given with the options below) and are followed by a NUL or newline
1206character. By default, it only prints the strings from the initialized
1207data sections of object files; for other types of files, it prints the
1208strings from the whole file.
1209
1210@code{strings} is mainly useful for determining the contents of non-text
1211files.
1212
1213@table @code
1214@item -a
1215@itemx --all
1216@itemx -
1217Do not scan only the initialized data section of object files; scan
1218the whole files.
1219
1220@item -f
1221@itemx --print-file-name
1222Print the name of the file before each string.
1223
b26ac613 1224@item --help
ba7c8e29
DM
1225Print a summary of the program usage on the standard output and exit.
1226
ba7c8e29 1227@itemx -@var{min-len}
b26ac613 1228@item -n @var{min-len}
ba7c8e29
DM
1229@itemx --bytes=@var{min-len}
1230Print sequences of characters that are at least @var{min-len} characters
1231long, instead of the default 4.
1232
1233@item -o
b26ac613
DM
1234Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
1235act like @samp{-t d} instead. Since we can not be compatible with both
1236ways, we simply chose one.
ba7c8e29
DM
1237
1238@item -t @var{radix}
1239@itemx --radix=@var{radix}
1240Print the offset within the file before each string. The single
1241character argument specifies the radix of the offset---@samp{o} for
1242octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
1243
eae04238
DM
1244@item --target=@var{bfdname}
1245@cindex object code format
1246Specify an object code format other than your system's default format.
1247@xref{Target Selection}, for more information.
1248
ba7c8e29
DM
1249@item -v
1250@itemx --version
1251Print the program version number on the standard output and exit.
1252@end table
1253
eae04238 1254@node strip
c72af735
RP
1255@chapter strip
1256
1257@kindex strip
1258@cindex removing symbols
1259@cindex discarding symbols
1815e42c 1260@cindex symbols, discarding
c72af735
RP
1261
1262@smallexample
eae04238
DM
1263strip [ -F @var{bfdname} | --target=@var{bfdname} | --target=@var{bfdname} ]
1264 [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1265 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
b703c078
DM
1266 [ -s | --strip-all ] [ -S | -g | --strip-debug ]
1267 [ -x | --discard-all ] [ -X | --discard-locals ]
0aca460e 1268 [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
b26ac613 1269 [ -v | --verbose ] [ -V | --version ] [ --help ]
b703c078 1270 @var{objfile}@dots{}
c72af735
RP
1271@end smallexample
1272
e31e9a8d 1273GNU @code{strip} discards all symbols from object files
ec40bbb8 1274@var{objfile}. The list of object files may include archives.
b26ac613 1275At least one object file must be given.
c72af735 1276
ec40bbb8 1277@code{strip} modifies the files named in its argument,
c72af735 1278rather than writing modified copies under different names.
c72af735 1279
c72af735 1280@table @code
eae04238
DM
1281@item -F @var{bfdname}
1282@itemx --target=@var{bfdname}
b26ac613 1283Treat the original @var{objfile} as a file with the object
eae04238
DM
1284code format @var{bfdname}, and rewrite it in the same format.
1285@xref{Target Selection}, for more information.
b26ac613
DM
1286
1287@item --help
1288Show a summary of the options to @code{strip} and exit.
1289
eae04238
DM
1290@item -I @var{bfdname}
1291@itemx --input-target=@var{bfdname}
ec40bbb8 1292Treat the original @var{objfile} as a file with the object
eae04238
DM
1293code format @var{bfdname}.
1294@xref{Target Selection}, for more information.
918c2f61 1295
eae04238
DM
1296@item -O @var{bfdname}
1297@itemx --output-target=@var{bfdname}
1298Replace @var{objfile} with a file in the output format @var{bfdname}.
1299@xref{Target Selection}, for more information.
918c2f61 1300
0aca460e
ILT
1301@item -R @var{sectionname}
1302@itemx --remove-section=@var{sectionname}
1303Remove any section named @var{sectionname} from the output file. This
1304option may be given more than once. Note that using this option
1305inappropriately may make the output file unusable.
1306
b703c078
DM
1307@item -s
1308@itemx --strip-all
1309Remove all symbols.
1310
918c2f61
PB
1311@item -g
1312@itemx -S
1313@itemx --strip-debug
1314Remove debugging symbols only.
1315
1316@item -x
1317@itemx --discard-all
1318Remove non-global symbols.
1319
1320@item -X
1321@itemx --discard-locals
1322Remove compiler-generated local symbols.
ec40bbb8 1323(These usually start with @samp{L} or @samp{.}.)
918c2f61
PB
1324
1325@item -V
1326@itemx --version
ec40bbb8 1327Show the version number for @code{strip}.
918c2f61 1328
1815e42c 1329@item -v
918c2f61
PB
1330@itemx --verbose
1331Verbose output: list all object files modified. In the case of
1269d441 1332archives, @samp{strip -v} lists all members of the archive.
c72af735
RP
1333@end table
1334
eae04238 1335@node c++filt
b6216af2
PB
1336@chapter c++filt
1337
1338@kindex c++filt
1339@cindex demangling C++ symbols
1340
b26ac613
DM
1341@smallexample
1342c++filt [ -_ | --strip-underscores ]
6f88f031 1343 [ -n | --no-strip-underscores ]
b26ac613 1344 [ -s @var{format} | --format=@var{format} ]
d6a4c375 1345 [ --help ] [ --version ] [ @var{symbol}@dots{} ]
b26ac613
DM
1346@end smallexample
1347
6c69b6bd
JO
1348The C++ language provides function overloading, which means that you can
1349write many functions with the same name (providing each takes parameters
1350of different types). All C++ function names are encoded into a
b26ac613 1351low-level assembly label (this process is known as
6c69b6bd
JO
1352@dfn{mangling}). The @code{c++filt} program does the inverse mapping: it
1353decodes (@dfn{demangles}) low-level names into user-level names so that
1354the linker can keep these overloaded functions from clashing.
1355
1356Every alphanumeric word (consisting of letters, digits, underscores,
1357dollars, or periods) seen in the input is a potential label. If the
1358label decodes into a C++ name, the C++ name replaces the low-level
1359name in the output.
b6216af2 1360
d6a4c375 1361You can use @code{c++filt} to decipher individual symbols:
6c69b6bd
JO
1362
1363@example
1364c++filt @var{symbol}
1365@end example
1366
d6a4c375
DM
1367If no @var{symbol} arguments are given, @code{c++filt} reads symbol
1368names from the standard input and writes the demangled names to the
1369standard output. All results are printed on the standard output.
b6216af2 1370
b26ac613
DM
1371@table @code
1372@item -_
94e9ad77 1373@itemx --strip-underscores
b26ac613
DM
1374On some systems, both the C and C++ compilers put an underscore in front
1375of every name. For example, the C name @code{foo} gets the low-level
6f88f031
ILT
1376name @code{_foo}. This option removes the initial underscore. Whether
1377@code{c++filt} removes the underscore by default is target dependent.
1378
1379@item -n
1380@itemx --no-strip-underscores
1381Do not remove the initial underscore.
b26ac613
DM
1382
1383@item -s @var{format}
1384@itemx --format=@var{format}
1385GNU @code{nm} can decode three different methods of mangling, used by
1386different C++ compilers. The argument to this option selects which
1387method it uses:
1388
1389@table @code
1390@item gnu
1391the one used by the GNU compiler (the default method)
1392@item lucid
1393the one used by the Lucid compiler
1394@item arm
1395the one specified by the C++ Annotated Reference Manual
1396@end table
1397
1398@item --help
1399Print a summary of the options to @code{c++filt} and exit.
1400
1401@item --version
1402Print the version number of @code{c++filt} and exit.
1403@end table
b6216af2 1404
5eac46ae
JO
1405@quotation
1406@emph{Warning:} @code{c++filt} is a new utility, and the details of its
1407user interface are subject to change in future releases. In particular,
1408a command-line option may be required in the the future to decode a name
1409passed as an argument on the command line; in other words,
1410
1411@example
b26ac613 1412c++filt @var{symbol}
5eac46ae
JO
1413@end example
1414
1415@noindent
1416may in a future release become
1417
1418@example
b26ac613 1419c++filt @var{option} @var{symbol}
5eac46ae
JO
1420@end example
1421@end quotation
1422
eae04238 1423@node nlmconv
94e9ad77
JO
1424@chapter nlmconv
1425
1426@code{nlmconv} converts a relocatable object file into a NetWare
8981cac5
JO
1427Loadable Module.
1428
1429@ignore
1430@code{nlmconv} currently works with @samp{i386} object
4961ce5b
JO
1431files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
1432object files in @sc{elf}, or @code{a.out} format@footnote{
1433@code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
1434format in the Binary File Descriptor library. It has only been tested
1435with the above formats.}.
8981cac5 1436@end ignore
4961ce5b
JO
1437
1438@quotation
1439@emph{Warning:} @code{nlmconv} is not always built as part of the binary
1440utilities, since it is only useful for NLM targets.
1441@end quotation
94e9ad77
JO
1442
1443@smallexample
eae04238
DM
1444nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
1445 [ -O @var{bfdname} | --output-target=@var{bfdname} ]
94e9ad77 1446 [ -T @var{headerfile} | --header-file=@var{headerfile} ]
20465f8b 1447 [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
94e9ad77
JO
1448 [ -h | --help ] [ -V | --version ]
1449 @var{infile} @var{outfile}
1450@end smallexample
1451
1452@code{nlmconv} converts the relocatable @samp{i386} object file
1453@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
1454reading @var{headerfile} for NLM header information. For instructions
5b0ba16d
JO
1455on writing the NLM command file language used in header files, see the
1456@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
1457Development and Tools Overview}, which is part of the NLM Software
1458Developer's Kit (``NLM SDK''), available from Novell, Inc.
1459@code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
eae04238 1460@var{infile}; see @ref{BFD,,BFD,ld.info,Using LD}, for
5b0ba16d 1461more information.
94e9ad77 1462
20465f8b
JO
1463@code{nlmconv} can perform a link step. In other words, you can list
1464more than one object file for input if you list them in the definitions
1465file (rather than simply specifying one input file on the command line).
1466In this case, @code{nlmconv} calls the linker for you.
1467
94e9ad77 1468@table @code
eae04238
DM
1469@item -I @var{bfdname}
1470@itemx --input-target=@var{bfdname}
94e9ad77 1471Object format of the input file. @code{nlmconv} can usually determine
eae04238
DM
1472the format of a given file (so no default is necessary).
1473@xref{Target Selection}, for more information.
94e9ad77 1474
eae04238
DM
1475@item -O @var{bfdname}
1476@itemx --output-target=@var{bfdname}
94e9ad77
JO
1477Object format of the output file. @code{nlmconv} infers the output
1478format based on the input format, e.g. for a @samp{i386} input file the
eae04238
DM
1479output format is @samp{nlm32-i386}.
1480@xref{Target Selection}, for more information.
94e9ad77
JO
1481
1482@item -T @var{headerfile}
1483@itemx --header-file=@var{headerfile}
1484Reads @var{headerfile} for NLM header information. For instructions on
5b0ba16d
JO
1485writing the NLM command file language used in header files, see@ see the
1486@samp{linkers} section, of the @cite{NLM Development and Tools
1487Overview}, which is part of the NLM Software Developer's Kit, available
1488from Novell, Inc.
94e9ad77 1489
20465f8b
JO
1490@item -d
1491@itemx --debug
1492Displays (on standard error) the linker command line used by @code{nlmconv}.
1493
1494@item -l @var{linker}
1495@itemx --linker=@var{linker}
1496Use @var{linker} for any linking. @var{linker} can be an abosolute or a
1497relative pathname.
1498
94e9ad77
JO
1499@item -h
1500@itemx --help
1501Prints a usage summary.
1502
1503@item -V
1504@itemx --version
1505Prints the version number for @code{nlmconv}.
1506@end table
1507
eae04238
DM
1508@node Selecting The Target System
1509@chapter Selecting the target system
1510
8981cac5
JO
1511You can specify three aspects of the target system to the @sc{gnu}
1512binary file utilities, each in several ways:
eae04238
DM
1513
1514@itemize @bullet
1515@item
8981cac5 1516the target
eae04238
DM
1517
1518@item
8981cac5 1519the architecture
eae04238
DM
1520
1521@item
8981cac5 1522the linker emulation (which applies to the linker only)
eae04238
DM
1523@end itemize
1524
1525In the following summaries, the lists of ways to specify values are in
8981cac5
JO
1526order of decreasing precedence. The ways listed first override those
1527listed later.
eae04238 1528
8981cac5
JO
1529The commands to list valid values only list the values for which the
1530programs you are running were configured. If they were configured with
eae04238
DM
1531@samp{--with-targets=all}, the commands list most of the available
1532values, but a few are left out; not all targets can be configured in at
8981cac5
JO
1533once because some of them can only be configured @dfn{native} (on hosts
1534with the same type as the target system).
eae04238
DM
1535
1536@menu
1537* Target Selection::
1538* Architecture Selection::
1539* Linker Emulation Selection::
1540@end menu
1541
1542@node Target Selection
8981cac5 1543@section Target Selection
eae04238
DM
1544
1545A @dfn{target} is an object file format. A given target may be
1546supported for multiple architectures (@pxref{Architecture Selection}).
8981cac5
JO
1547A target selection may also have variations for different operating
1548systems or architectures.
eae04238 1549
8981cac5
JO
1550The command to list valid target values is @samp{objdump -i}
1551(the first column of output contains the relevant information).
eae04238 1552
10f2a7f6
JO
1553Some sample values are: @samp{a.out-hp300bsd}, @samp{ecoff-littlemips},
1554@samp{a.out-sunos-big}.
eae04238 1555
8981cac5 1556@subheading @code{objdump} Target
eae04238
DM
1557
1558Ways to specify:
1559
1560@enumerate
1561@item
8981cac5 1562command line option: @samp{-b} or @samp{--target}
eae04238
DM
1563
1564@item
1565environment variable @code{GNUTARGET}
1566
1567@item
1568deduced from the input file
1569@end enumerate
1570
8981cac5 1571@subheading @code{objcopy} and @code{strip} Input Target
eae04238
DM
1572
1573Ways to specify:
1574
1575@enumerate
1576@item
8981cac5 1577command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1578
1579@item
1580environment variable @code{GNUTARGET}
1581
1582@item
1583deduced from the input file
1584@end enumerate
1585
8981cac5 1586@subheading @code{objcopy} and @code{strip} Output Target
eae04238
DM
1587
1588Ways to specify:
1589
1590@enumerate
1591@item
8981cac5 1592command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
eae04238
DM
1593
1594@item
8981cac5 1595the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
eae04238
DM
1596
1597@item
1598environment variable @code{GNUTARGET}
1599
1600@item
1601deduced from the input file
1602@end enumerate
1603
8981cac5 1604@subheading @code{nm}, @code{size}, and @code{strings} Target
eae04238
DM
1605
1606Ways to specify:
1607
1608@enumerate
1609@item
8981cac5 1610command line option: @samp{--target}
eae04238
DM
1611
1612@item
1613environment variable @code{GNUTARGET}
1614
1615@item
1616deduced from the input file
1617@end enumerate
1618
8981cac5 1619@subheading Linker Input Target
eae04238
DM
1620
1621Ways to specify:
1622
1623@enumerate
1624@item
8981cac5 1625command line option: @samp{-b} or @samp{--format}
eae04238
DM
1626(@pxref{Options,,Options,ld.info,Using LD})
1627
1628@item
1629script command @code{TARGET}
1630(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1631
1632@item
1633environment variable @code{GNUTARGET}
1634(@pxref{Environment,,Environment,ld.info,Using LD})
1635
1636@item
1637the default target of the selected linker emulation
1638(@pxref{Linker Emulation Selection})
1639@end enumerate
1640
8981cac5 1641@subheading Linker Output Target
eae04238
DM
1642
1643Ways to specify:
1644
1645@enumerate
1646@item
8981cac5 1647command line option: @samp{-oformat}
eae04238
DM
1648(@pxref{Options,,Options,ld.info,Using LD})
1649
1650@item
1651script command @code{OUTPUT_FORMAT}
1652(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1653
1654@item
8981cac5 1655the linker input target (see ``Linker Input Target'' above)
eae04238
DM
1656@end enumerate
1657
1658@node Architecture Selection
1659@section Architecture selection
1660
8981cac5
JO
1661An @dfn{architecture} is a type of @sc{cpu} on which an object file is
1662to run. Its name may contain a colon, separating the name of the
1663processor family from the name of the particular @sc{cpu}.
eae04238 1664
8981cac5
JO
1665The command to list valid architecture values is @samp{objdump -i} (the
1666second column contains the relevant information).
eae04238
DM
1667
1668Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
1669
8981cac5 1670@subheading @code{objdump} Architecture
eae04238
DM
1671
1672Ways to specify:
1673
1674@enumerate
1675@item
8981cac5 1676command line option: @samp{-m} or @samp{--architecture}
eae04238
DM
1677
1678@item
1679deduced from the input file
1680@end enumerate
1681
8981cac5 1682@subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
eae04238
DM
1683
1684Ways to specify:
1685
1686@enumerate
1687@item
1688deduced from the input file
1689@end enumerate
1690
8981cac5 1691@subheading Linker Input Architecture
eae04238
DM
1692
1693Ways to specify:
1694
1695@enumerate
1696@item
1697deduced from the input file
1698@end enumerate
1699
8981cac5 1700@subheading Linker Output Architecture
eae04238
DM
1701
1702Ways to specify:
1703
1704@enumerate
1705@item
1706script command @code{OUTPUT_ARCH}
1707(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
1708
1709@item
1710the default architecture from the linker output target
8981cac5 1711(@pxref{Target Selection})
eae04238
DM
1712@end enumerate
1713
1714@node Linker Emulation Selection
1715@section Linker emulation selection
1716
1717A linker @dfn{emulation} is a ``personality'' of the linker, which gives
1718the linker default values for the other aspects of the target system.
1719In particular, it consists of
1720
1721@itemize @bullet
1722@item
8981cac5 1723the linker script
eae04238
DM
1724
1725@item
8981cac5 1726the target
eae04238
DM
1727
1728@item
1729several ``hook'' functions that are run at certain stages of the linking
8981cac5 1730process to do special things that some targets require
eae04238
DM
1731@end itemize
1732
8981cac5 1733The command to list valid linker emulation values is @samp{ld -V}.
eae04238
DM
1734
1735Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
1736
1737Ways to specify:
1738
1739@enumerate
1740@item
8981cac5 1741command line option: @samp{-m}
eae04238
DM
1742(@pxref{Options,,Options,ld.info,Using LD})
1743
1744@item
1745environment variable @code{LDEMULATION}
1746
1747@item
1748compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
1749which comes from @code{EMUL} in @file{config/@var{target}.mt}
1750@end enumerate
1751
1752@node Index
c72af735
RP
1753@unnumbered Index
1754
1755@printindex cp
1756
1757@contents
1758@bye
This page took 0.244308 seconds and 4 git commands to generate.