\input texinfo @c -*- Texinfo -*-
@setfilename binutils.info
-@c Copyright 2001 Free Software Foundation, Inc.
+@c Copyright 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
+@c man begin INCLUDE
@include config.texi
+@c man end
@ifinfo
@format
@ifinfo
@c man begin COPYRIGHT
-Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc.
+Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with no Invariant Sections, with no Front-Cover Texts, and with no
Back-Cover Texts. A copy of the license is included in the
-section entitled "GNU Free Documentation License".
+section entitled ``GNU Free Documentation License''.
@c man end
@ignore
@c This file documents the GNU binary utilities "ar", "ld", "objcopy",
@c "objdump", "nm", "size", "strings", "strip", "readelf" and "ranlib".
@c
-@c Copyright (C) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001 Free Software Foundation, Inc.
+@c Copyright (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
+@c 2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
@c
@c This text may be freely distributed under the terms of the GNU
@c Free Documentation License.
@title The @sc{gnu} Binary Utilities
@subtitle Version @value{VERSION}
@sp 1
-@subtitle May 1993
+@subtitle @value{UPDATED}
@author Roland H. Pesch
@author Jeffrey M. Osier
@author Cygnus Support
@end tex
@vskip 0pt plus 1filll
-Copyright @copyright{} 1991, 92, 93, 94, 95, 96, 97, 1998, 2000, 2001 Free Software Foundation, Inc.
+Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
+2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with no Invariant Sections, with no Front-Cover Texts, and with no
Back-Cover Texts. A copy of the license is included in the
- section entitled "GNU Free Documentation License".
+ section entitled ``GNU Free Documentation License''.
@end titlepage
@top Introduction
@cindex version
-This brief manual contains preliminary documentation for the @sc{gnu} binary
+This brief manual contains documentation for the @sc{gnu} binary
utilities (collectively version @value{VERSION}):
@iftex
* nlmconv:: Converts object code into an NLM
* windres:: Manipulate Windows resources
* dlltool:: Create files needed to build and use DLLs
+* Common Options:: Command-line options for all utilities
* Selecting The Target System:: How these utilities determine the target.
* Reporting Bugs:: Reporting Bugs
* GNU Free Documentation License:: GNU Free Documentation License
@c man begin DESCRIPTION ar
-The @sc{gnu} @code{ar} program creates, modifies, and extracts from
+The @sc{gnu} @command{ar} program creates, modifies, and extracts from
archives. An @dfn{archive} is a single file holding a collection of
other files in a structure that makes it possible to retrieve
the original individual files (called @dfn{members} of the archive).
extraction.
@cindex name length
-@sc{gnu} @code{ar} can maintain archives whose members have names of any
-length; however, depending on how @code{ar} is configured on your
+@sc{gnu} @command{ar} can maintain archives whose members have names of any
+length; however, depending on how @command{ar} is configured on your
system, a limit on member-name length may be imposed for compatibility
with archive formats maintained with other tools. If it exists, the
limit is often 15 characters (typical of formats related to a.out) or 16
characters (typical of formats related to coff).
@cindex libraries
-@code{ar} is considered a binary utility because archives of this sort
+@command{ar} is considered a binary utility because archives of this sort
are most often used as @dfn{libraries} holding commonly needed
subroutines.
@cindex symbol index
-@code{ar} creates an index to the symbols defined in relocatable
+@command{ar} creates an index to the symbols defined in relocatable
object modules in the archive when you specify the modifier @samp{s}.
-Once created, this index is updated in the archive whenever @code{ar}
+Once created, this index is updated in the archive whenever @command{ar}
makes a change to its contents (save for the @samp{q} update operation).
An archive with such an index speeds up linking to the library, and
allows routines in the library to call each other without regard to
their placement in the archive.
You may use @samp{nm -s} or @samp{nm --print-armap} to list this index
-table. If an archive lacks the table, another form of @code{ar} called
-@code{ranlib} can be used to add just the table.
+table. If an archive lacks the table, another form of @command{ar} called
+@command{ranlib} can be used to add just the table.
-@cindex compatibility, @code{ar}
-@cindex @code{ar} compatibility
-@sc{gnu} @code{ar} is designed to be compatible with two different
+@cindex compatibility, @command{ar}
+@cindex @command{ar} compatibility
+@sc{gnu} @command{ar} is designed to be compatible with two different
facilities. You can control its activity using command-line options,
-like the different varieties of @code{ar} on Unix systems; or, if you
-specify the single command-line option @samp{-M}, you can control it
+like the different varieties of @command{ar} on Unix systems; or, if you
+specify the single command-line option @option{-M}, you can control it
with a script supplied via standard input, like the MRI ``librarian''
program.
@c man end
@menu
-* ar cmdline:: Controlling @code{ar} on the command line
-* ar scripts:: Controlling @code{ar} with a script
+* ar cmdline:: Controlling @command{ar} on the command line
+* ar scripts:: Controlling @command{ar} with a script
@end menu
@page
@node ar cmdline
-@section Controlling @code{ar} on the command line
+@section Controlling @command{ar} on the Command Line
@smallexample
@c man begin SYNOPSIS ar
-ar [-X32_64] [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
+ar [@option{-X32_64}] [@option{-}]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]
@c man end
@end smallexample
-@cindex Unix compatibility, @code{ar}
-When you use @code{ar} in the Unix style, @code{ar} insists on at least two
+@cindex Unix compatibility, @command{ar}
+When you use @command{ar} in the Unix style, @command{ar} insists on at least two
arguments to execute: one keyletter specifying the @emph{operation}
(optionally accompanied by other keyletters specifying
@emph{modifiers}), and the archive name to act on.
@c man begin OPTIONS ar
-@sc{gnu} @code{ar} allows you to mix the operation code @var{p} and modifier
+@sc{gnu} @command{ar} allows you to mix the operation code @var{p} and modifier
flags @var{mod} in any order, within the first command-line argument.
If you wish, you may begin the first command-line argument with a
The @var{p} keyletter specifies what operation to execute; it may be
any of the following, but you must specify only one of them:
-@table @code
+@table @samp
@item d
@cindex deleting from archive
@emph{Delete} modules from the archive. Specify the names of modules to
be deleted as @var{member}@dots{}; the archive is untouched if you
specify no files to delete.
-If you specify the @samp{v} modifier, @code{ar} lists each module
+If you specify the @samp{v} modifier, @command{ar} lists each module
as it is deleted.
@item m
The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this
operation; new members are always placed at the end of the archive.
-The modifier @samp{v} makes @code{ar} list each file as it is appended.
+The modifier @samp{v} makes @command{ar} list each file as it is appended.
Since the point of this operation is speed, the archive's symbol table
index is not updated, even if it already existed; you can use @samp{ar s} or
-@code{ranlib} explicitly to update the symbol table index.
+@command{ranlib} explicitly to update the symbol table index.
However, too many different systems assume quick append rebuilds the
-index, so GNU ar implements @code{q} as a synonym for @code{r}.
+index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.
@item r
@cindex replacement in archive
previously existing members are deleted if their names match those being
added.
-If one of the files named in @var{member}@dots{} does not exist, @code{ar}
+If one of the files named in @var{member}@dots{} does not exist, @command{ar}
displays an error message, and leaves undisturbed any existing members
of the archive matching that name.
@cindex extract from archive
@emph{Extract} members (named @var{member}) from the archive. You can
use the @samp{v} modifier with this operation, to request that
-@code{ar} list each name as it extracts it.
+@command{ar} list each name as it extracts it.
If you do not specify a @var{member}, all files in the archive
are extracted.
A number of modifiers (@var{mod}) may immediately follow the @var{p}
keyletter, to specify variations on an operation's behavior:
-@table @code
+@table @samp
@item a
@cindex relative placement in archive
Add new files @emph{after} an existing member of the
using this modifier.
@item f
-Truncate names in the archive. @sc{gnu} @code{ar} will normally permit file
+Truncate names in the archive. @sc{gnu} @command{ar} will normally permit file
names of any length. This will cause it to create archives which are
-not compatible with the native @code{ar} program on some systems. If
+not compatible with the native @command{ar} program on some systems. If
this is a concern, the @samp{f} modifier may be used to truncate file
names when putting them in the archive.
@item P
Use the full path name when matching names in the archive. @sc{gnu}
-@code{ar} can not create an archive with a full path name (such archives
+@command{ar} can not create an archive with a full path name (such archives
are not POSIX complaint), but other archive creators can. This option
-will cause @sc{gnu} @code{ar} to match file names using a complete path
+will cause @sc{gnu} @command{ar} to match file names using a complete path
name, which can be convenient when extracting a single file from an
archive created by another tool.
when the modifier @samp{v} is appended.
@item V
-This modifier shows the version number of @code{ar}.
+This modifier shows the version number of @command{ar}.
@end table
-@code{ar} ignores an initial option spelt @code{-X32_64}, for
+@command{ar} ignores an initial option spelt @samp{-X32_64}, for
compatibility with AIX. The behaviour produced by this option is the
-default for GNU @code{ar}. @code{ar} does not support any of the other
-@code{-X} options; in particular, it does not support @code{-X32}
-which is the default for AIX @code{ar}.
+default for @sc{gnu} @command{ar}. @command{ar} does not support any of the other
+@samp{-X} options; in particular, it does not support @option{-X32}
+which is the default for AIX @command{ar}.
@c man end
@end ignore
@node ar scripts
-@section Controlling @code{ar} with a script
+@section Controlling @command{ar} with a Script
@smallexample
ar -M [ <@var{script} ]
@end smallexample
-@cindex MRI compatibility, @code{ar}
-@cindex scripts, @code{ar}
-If you use the single command-line option @samp{-M} with @code{ar}, you
+@cindex MRI compatibility, @command{ar}
+@cindex scripts, @command{ar}
+If you use the single command-line option @samp{-M} with @command{ar}, you
can control its operation with a rudimentary command language. This
-form of @code{ar} operates interactively if standard input is coming
-directly from a terminal. During interactive use, @code{ar} prompts for
+form of @command{ar} operates interactively if standard input is coming
+directly from a terminal. During interactive use, @command{ar} prompts for
input (the prompt is @samp{AR >}), and continues executing even after
errors. If you redirect standard input to a script file, no prompts are
-issued, and @code{ar} abandons execution (with a nonzero exit code)
+issued, and @command{ar} abandons execution (with a nonzero exit code)
on any error.
-The @code{ar} command language is @emph{not} designed to be equivalent
+The @command{ar} command language is @emph{not} designed to be equivalent
to the command-line options; in fact, it provides somewhat less control
over archives. The only purpose of the command language is to ease the
-transition to @sc{gnu} @code{ar} for developers who already have scripts
+transition to @sc{gnu} @command{ar} for developers who already have scripts
written for the MRI ``librarian'' program.
-The syntax for the @code{ar} command language is straightforward:
+The syntax for the @command{ar} command language is straightforward:
@itemize @bullet
@item
commands are recognized in upper or lower case; for example, @code{LIST}
or @samp{;} is ignored.
@item
-Whenever you use a list of names as part of the argument to an @code{ar}
+Whenever you use a list of names as part of the argument to an @command{ar}
command, you can separate the individual names with either commas or
blanks. Commas are shown in the explanations below, for clarity.
of the current command.
@end itemize
-Here are the commands you can use in @code{ar} scripts, or when using
-@code{ar} interactively. Three of them have special significance:
+Here are the commands you can use in @command{ar} scripts, or when using
+@command{ar} interactively. Three of them have special significance:
@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is
a temporary file required for most of the other commands.
@samp{ar -tv @var{archive} @var{module}@dots{}}.
Output normally goes to the standard output stream; however, if you
-specify @var{outputfile} as a final argument, @code{ar} directs the
+specify @var{outputfile} as a final argument, @command{ar} directs the
output to that file.
@item END
-Exit from @code{ar}, with a @code{0} exit code to indicate successful
+Exit from @command{ar}, with a @code{0} exit code to indicate successful
completion. This command does not save the output file; if you have
changed the current archive since the last @code{SAVE} command, those
changes are lost.
@item LIST
Display full contents of the current archive, in ``verbose'' style
regardless of the state of @code{VERBOSE}. The effect is like @samp{ar
-tv @var{archive}}. (This single command is a @sc{gnu} @code{ar}
+tv @var{archive}}. (This single command is a @sc{gnu} @command{ar}
enhancement, rather than present for MRI compatibility.)
Requires prior use of @code{OPEN} or @code{CREATE}.
@chapter ld
@cindex linker
@kindex ld
-The @sc{gnu} linker @code{ld} is now described in a separate manual.
+The @sc{gnu} linker @command{ld} is now described in a separate manual.
@xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.
@end iftex
@smallexample
@c man begin SYNOPSIS nm
-nm [ -a | --debug-syms ] [ -g | --extern-only ]
- [ -B ] [ -C | --demangle[=@var{style}] ] [ -D | --dynamic ]
- [ -s | --print-armap ] [ -A | -o | --print-file-name ]
- [ -n | -v | --numeric-sort ] [ -p | --no-sort ]
- [ -r | --reverse-sort ] [ --size-sort ] [ -u | --undefined-only ]
- [ -t @var{radix} | --radix=@var{radix} ] [ -P | --portability ]
- [ --target=@var{bfdname} ] [ -f @var{format} | --format=@var{format} ]
- [ --defined-only ] [-l | --line-numbers ] [ --no-demangle ]
- [ -V | --version ] [ -X 32_64 ] [ --help ] [ @var{objfile}@dots{} ]
+nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]
+ [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]
+ [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]
+ [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]
+ [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]
+ [@option{-r}|@option{--reverse-sort}] [@option{--size-sort}] [@option{-u}|@option{--undefined-only}]
+ [@option{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]
+ [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]
+ [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]
+ [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}] [@var{objfile}@dots{}]
@c man end
@end smallexample
@c man begin DESCRIPTION nm
-@sc{gnu} @code{nm} lists the symbols from object files @var{objfile}@dots{}.
-If no object files are listed as arguments, @code{nm} assumes the file
+@sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.
+If no object files are listed as arguments, @command{nm} assumes the file
@file{a.out}.
-For each symbol, @code{nm} shows:
+For each symbol, @command{nm} shows:
@itemize @bullet
@item
such as a global int variable as opposed to a large global array.
@item I
-The symbol is an indirect reference to another symbol. This is a GNU
+The symbol is an indirect reference to another symbol. This is a @sc{gnu}
extension to the a.out object file format which is rarely used.
@item N
weak object symbol. When a weak defined symbol is linked with a normal
defined symbol, the normal defined symbol is used with no error.
When a weak undefined symbol is linked and the symbol is not defined,
-the value of the weak symbol becomes zero with no error.
+the value of the symbol is determined in a system-specific manner without
+error. On some systems, uppercase indicates that a default value has been
+specified.
+
@item -
The symbol is a stabs symbol in an a.out object file. In this case, the
next values printed are the stabs other field, the stabs desc field, and
-the stab type. Stabs symbols are used to hold debugging information;
-for more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
+the stab type. Stabs symbols are used to hold debugging information.
+@ifclear man
+For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The
``stabs'' debug format}.
+@end ifclear
@item ?
The symbol type is unknown, or object file format specific.
The long and short forms of options, shown here as alternatives, are
equivalent.
-@table @code
+@table @env
@item -A
@itemx -o
@itemx --print-file-name
listed.
@item -B
-@cindex @code{nm} format
-@cindex @code{nm} compatibility
-The same as @samp{--format=bsd} (for compatibility with the MIPS @code{nm}).
+@cindex @command{nm} format
+@cindex @command{nm} compatibility
+The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).
@item -C
@itemx --demangle[=@var{style}]
@item -f @var{format}
@itemx --format=@var{format}
-@cindex @code{nm} format
-@cindex @code{nm} compatibility
+@cindex @command{nm} format
+@cindex @command{nm} compatibility
Use the output format @var{format}, which can be @code{bsd},
@code{sysv}, or @code{posix}. The default is @code{bsd}.
Only the first character of @var{format} is significant; it can be
Use the POSIX.2 standard output format instead of the default format.
Equivalent to @samp{-f posix}.
+@item -S
+@itemx --print-size
+Print size, not the value, of defined symbols for the @code{bsd} output format.
+
@item -s
@itemx --print-armap
@cindex symbol index, listing
When listing symbols from archive members, include the index: a mapping
-(stored in the archive by @code{ar} or @code{ranlib}) of which modules
+(stored in the archive by @command{ar} or @command{ranlib}) of which modules
contain definitions for which names.
@item -r
@item --size-sort
Sort symbols by size. The size is computed as the difference between
the value of the symbol and the value of the symbol with the next higher
-value. The size of the symbol is printed, rather than the value.
+value. If the @code{bsd} output format is used the size of the symbol
+is printed, rather than the value, and @samp{-S} must be used in order
+both size and value to be printed.
+
+@item --special-syms
+Display symbols which have a target-specific special meaning. These
+symbols are usually used by the target for some special processing and
+are not normally helpful when included included in the normal symbol
+lists. For example for ARM targets this option would skip the mapping
+symbols used to mark transistions between ARM code, THUMB code and
+data.
@item -t @var{radix}
@itemx --radix=@var{radix}
@item -V
@itemx --version
-Show the version number of @code{nm} and exit.
+Show the version number of @command{nm} and exit.
@item -X
This option is ignored for compatibility with the AIX version of
-@code{nm}. It takes one parameter which must be the string
-@code{32_64}. The default mode of AIX @code{nm} corresponds
-to @code{-X 32}, which is not supported by @sc{gnu} @code{nm}.
+@command{nm}. It takes one parameter which must be the string
+@option{32_64}. The default mode of AIX @command{nm} corresponds
+to @option{-X 32}, which is not supported by @sc{gnu} @command{nm}.
@item --help
-Show a summary of the options to @code{nm} and exit.
+Show a summary of the options to @command{nm} and exit.
@end table
@c man end
@smallexample
@c man begin SYNOPSIS objcopy
-objcopy [ -F @var{bfdname} | --target=@var{bfdname} ]
- [ -I @var{bfdname} | --input-target=@var{bfdname} ]
- [ -O @var{bfdname} | --output-target=@var{bfdname} ]
- [ -B @var{bfdarch} | --binary-architecture=@var{bfdarch} ]
- [ -S | --strip-all ] [ -g | --strip-debug ]
- [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
- [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
- [ -G @var{symbolname} | --keep-global-symbol=@var{symbolname}]
- [ -L @var{symbolname} | --localize-symbol=@var{symbolname} ]
- [ -W @var{symbolname} | --weaken-symbol=@var{symbolname} ]
- [ -x | --discard-all ] [ -X | --discard-locals ]
- [ -b @var{byte} | --byte=@var{byte} ]
- [ -i @var{interleave} | --interleave=@var{interleave} ]
- [ -j @var{sectionname} | --only-section=@var{sectionname} ]
- [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
- [ -p | --preserve-dates ] [ --debugging ]
- [ --gap-fill=@var{val} ] [ --pad-to=@var{address} ]
- [ --set-start=@var{val} ] [ --adjust-start=@var{incr} ]
- [ --change-addresses=@var{incr} ]
- [ --change-section-address @var{section}@{=,+,-@}@var{val} ]
- [ --change-section-lma @var{section}@{=,+,-@}@var{val} ]
- [ --change-section-vma @var{section}@{=,+,-@}@var{val} ]
- [ --change-warnings ] [ --no-change-warnings ]
- [ --set-section-flags @var{section}=@var{flags} ]
- [ --add-section @var{sectionname}=@var{filename} ]
- [ --change-leading-char ] [ --remove-leading-char ]
- [ --srec-len=@var{ival} ] [ --srec-forceS3 ]
- [ --redefine-sym @var{old}=@var{new} ] [ --weaken ]
- [ --keep-symbols=@var{filename} ]
- [ --strip-symbols=@var{filename} ]
- [ --keep-global-symbols=@var{filename} ]
- [ --localize-symbols=@var{filename} ]
- [ --weaken-symbols=@var{filename} ]
- [ -v | --verbose ] [ -V | --version ] [ --help ]
+objcopy [@option{-F} @var{bfdname}|@option{--target=}@var{bfdname}]
+ [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
+ [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
+ [@option{-B} @var{bfdarch}|@option{--binary-architecture=}@var{bfdarch}]
+ [@option{-S}|@option{--strip-all}]
+ [@option{-g}|@option{--strip-debug}]
+ [@option{-K} @var{symbolname}|@option{--keep-symbol=}@var{symbolname}]
+ [@option{-N} @var{symbolname}|@option{--strip-symbol=}@var{symbolname}]
+ [@option{--strip-unneeded-symbol=}@var{symbolname}]
+ [@option{-G} @var{symbolname}|@option{--keep-global-symbol=}@var{symbolname}]
+ [@option{-L} @var{symbolname}|@option{--localize-symbol=}@var{symbolname}]
+ [@option{--globalize-symbol=}@var{symbolname}]
+ [@option{-W} @var{symbolname}|@option{--weaken-symbol=}@var{symbolname}]
+ [@option{-w}|@option{--wildcard}]
+ [@option{-x}|@option{--discard-all}]
+ [@option{-X}|@option{--discard-locals}]
+ [@option{-b} @var{byte}|@option{--byte=}@var{byte}]
+ [@option{-i} @var{interleave}|@option{--interleave=}@var{interleave}]
+ [@option{-j} @var{sectionname}|@option{--only-section=}@var{sectionname}]
+ [@option{-R} @var{sectionname}|@option{--remove-section=}@var{sectionname}]
+ [@option{-p}|@option{--preserve-dates}]
+ [@option{--debugging}]
+ [@option{--gap-fill=}@var{val}]
+ [@option{--pad-to=}@var{address}]
+ [@option{--set-start=}@var{val}]
+ [@option{--adjust-start=}@var{incr}]
+ [@option{--change-addresses=}@var{incr}]
+ [@option{--change-section-address} @var{section}@{=,+,-@}@var{val}]
+ [@option{--change-section-lma} @var{section}@{=,+,-@}@var{val}]
+ [@option{--change-section-vma} @var{section}@{=,+,-@}@var{val}]
+ [@option{--change-warnings}] [@option{--no-change-warnings}]
+ [@option{--set-section-flags} @var{section}=@var{flags}]
+ [@option{--add-section} @var{sectionname}=@var{filename}]
+ [@option{--rename-section} @var{oldname}=@var{newname}[,@var{flags}]]
+ [@option{--change-leading-char}] [@option{--remove-leading-char}]
+ [@option{--srec-len=}@var{ival}] [@option{--srec-forceS3}]
+ [@option{--redefine-sym} @var{old}=@var{new}]
+ [@option{--redefine-syms=}@var{filename}]
+ [@option{--weaken}]
+ [@option{--keep-symbols=}@var{filename}]
+ [@option{--strip-symbols=}@var{filename}]
+ [@option{--strip-unneeded-symbols=}@var{filename}]
+ [@option{--keep-global-symbols=}@var{filename}]
+ [@option{--localize-symbols=}@var{filename}]
+ [@option{--globalize-symbols=}@var{filename}]
+ [@option{--weaken-symbols=}@var{filename}]
+ [@option{--alt-machine-code=}@var{index}]
+ [@option{--prefix-symbols=}@var{string}]
+ [@option{--prefix-sections=}@var{string}]
+ [@option{--prefix-alloc-sections=}@var{string}]
+ [@option{--add-gnu-debuglink=}@var{path-to-file}]
+ [@option{--keep-file-symbols}]
+ [@option{--only-keep-debug}]
+ [@option{--writable-text}]
+ [@option{--readonly-text}]
+ [@option{--pure}]
+ [@option{--impure}]
+ [@option{-v}|@option{--verbose}]
+ [@option{-V}|@option{--version}]
+ [@option{--help}] [@option{--info}]
@var{infile} [@var{outfile}]
@c man end
@end smallexample
@c man begin DESCRIPTION objcopy
-The @sc{gnu} @code{objcopy} utility copies the contents of an object
-file to another. @code{objcopy} uses the @sc{gnu} @sc{bfd} Library to
+The @sc{gnu} @command{objcopy} utility copies the contents of an object
+file to another. @command{objcopy} uses the @sc{gnu} @sc{bfd} Library to
read and write the object files. It can write the destination object
file in a format different from that of the source object file. The
-exact behavior of @code{objcopy} is controlled by command-line options.
-Note that @code{objcopy} should be able to copy a fully linked file
+exact behavior of @command{objcopy} is controlled by command-line options.
+Note that @command{objcopy} should be able to copy a fully linked file
between any two formats. However, copying a relocatable object file
between any two formats may not work as expected.
-@code{objcopy} creates temporary files to do its translations and
-deletes them afterward. @code{objcopy} uses @sc{bfd} to do all its
+@command{objcopy} creates temporary files to do its translations and
+deletes them afterward. @command{objcopy} uses @sc{bfd} to do all its
translation work; it has access to all the formats described in @sc{bfd}
and thus is able to recognize most formats without being told
explicitly. @xref{BFD,,BFD,ld.info,Using LD}.
-@code{objcopy} can be used to generate S-records by using an output
+@command{objcopy} can be used to generate S-records by using an output
target of @samp{srec} (e.g., use @samp{-O srec}).
-@code{objcopy} can be used to generate a raw binary file by using an
-output target of @samp{binary} (e.g., use @samp{-O binary}). When
-@code{objcopy} generates a raw binary file, it will essentially produce
+@command{objcopy} can be used to generate a raw binary file by using an
+output target of @samp{binary} (e.g., use @option{-O binary}). When
+@command{objcopy} generates a raw binary file, it will essentially produce
a memory dump of the contents of the input object file. All symbols and
relocation information will be discarded. The memory dump will start at
the load address of the lowest section copied into the output file.
When generating an S-record or a raw binary file, it may be helpful to
-use @samp{-S} to remove sections containing debugging information. In
-some cases @samp{-R} will be useful to remove sections which contain
+use @option{-S} to remove sections containing debugging information. In
+some cases @option{-R} will be useful to remove sections which contain
information that is not needed by the binary file.
-Note - @code{objcopy} is not able to change the endianness of its input
-files. If the input format has an endianness, (some formats do not),
-@code{objcopy} can only copy the inputs into file formats that have the
-same endianness or which have no endianness (eg @samp{srec}).
+Note---@command{objcopy} is not able to change the endianness of its input
+files. If the input format has an endianness (some formats do not),
+@command{objcopy} can only copy the inputs into file formats that have the
+same endianness or which have no endianness (e.g., @samp{srec}).
@c man end
@c man begin OPTIONS objcopy
-@table @code
+@table @env
@item @var{infile}
@itemx @var{outfile}
The input and output files, respectively.
-If you do not specify @var{outfile}, @code{objcopy} creates a
+If you do not specify @var{outfile}, @command{objcopy} creates a
temporary file and destructively renames the result with
the name of @var{infile}.
-@item -I @var{bfdname}
+@item -I @var{bfdname}
@itemx --input-target=@var{bfdname}
Consider the source file's object format to be @var{bfdname}, rather than
attempting to deduce it. @xref{Target Selection}, for more information.
@item -g
@itemx --strip-debug
-Do not copy debugging symbols from the source file.
+Do not copy debugging symbols or sections from the source file.
@item --strip-unneeded
Strip all symbols that are not needed for relocation processing.
@item -K @var{symbolname}
@itemx --keep-symbol=@var{symbolname}
-Copy only symbol @var{symbolname} from the source file. This option may
-be given more than once.
+When stripping symbols, keep symbol @var{symbolname} even if it would
+normally be stripped. This option may be given more than once.
@item -N @var{symbolname}
@itemx --strip-symbol=@var{symbolname}
Do not copy symbol @var{symbolname} from the source file. This option
may be given more than once.
+@item --strip-unneeded-symbol=@var{symbolname}
+Do not copy symbol @var{symbolname} from the source file unless it is needed
+by a relocation. This option may be given more than once.
+
@item -G @var{symbolname}
@itemx --keep-global-symbol=@var{symbolname}
Keep only symbol @var{symbolname} global. Make all other symbols local
@itemx --weaken-symbol=@var{symbolname}
Make symbol @var{symbolname} weak. This option may be given more than once.
+@item --globalize-symbol=@var{symbolname}
+Give symbol @var{symbolname} global scoping so that it is visible
+outside of the file in which it is defined. This option may be given
+more than once.
+
+@item -w
+@itemx --wildcard
+Permit regular expressions in @var{symbolname}s used in other command
+line options. The question mark (?), asterisk (*), backslash (\) and
+square brackets ([]) operators can be used anywhere in the symbol
+name. If the first character of the symbol name is the exclamation
+point (!) then the sense of the switch is reversed for that symbol.
+For example:
+
+@smallexample
+ -w -W !foo -W fo*
+@end smallexample
+
+would cause objcopy to weaken all symbols that start with ``fo''
+except for the symbol ``foo''.
+
@item -x
@itemx --discard-all
Do not copy non-global symbols from the source file.
@itemx --byte=@var{byte}
Keep only every @var{byte}th byte of the input file (header data is not
affected). @var{byte} can be in the range from 0 to @var{interleave}-1,
-where @var{interleave} is given by the @samp{-i} or @samp{--interleave}
+where @var{interleave} is given by the @option{-i} or @option{--interleave}
option, or the default of 4. This option is useful for creating files
to program @sc{rom}. It is typically used with an @code{srec} output
target.
@item -i @var{interleave}
@itemx --interleave=@var{interleave}
Only copy one out of every @var{interleave} bytes. Select which byte to
-copy with the @var{-b} or @samp{--byte} option. The default is 4.
-@code{objcopy} ignores this option if you do not specify either @samp{-b} or
-@samp{--byte}.
+copy with the @option{-b} or @option{--byte} option. The default is 4.
+@command{objcopy} ignores this option if you do not specify either @option{-b} or
+@option{--byte}.
@item -p
@itemx --preserve-dates
@item --pad-to @var{address}
Pad the output file up to the load address @var{address}. This is
done by increasing the size of the last section. The extra space is
-filled in with the value specified by @samp{--gap-fill} (default zero).
+filled in with the value specified by @option{--gap-fill} (default zero).
@item --set-start @var{val}
Set the start address of the new file to @var{val}. Not all object file
Set or change both the VMA address and the LMA address of the named
@var{section}. If @samp{=} is used, the section address is set to
@var{val}. Otherwise, @var{val} is added to or subtracted from the
-section address. See the comments under @samp{--change-addresses},
+section address. See the comments under @option{--change-addresses},
above. If @var{section} does not exist in the input file, a warning will
-be issued, unless @samp{--no-change-warnings} is used.
+be issued, unless @option{--no-change-warnings} is used.
@item --change-section-lma @var{section}@{=,+,-@}@var{val}
@cindex changing section LMA
especially those where a program is held in ROM, the two can be
different. If @samp{=} is used, the section address is set to
@var{val}. Otherwise, @var{val} is added to or subtracted from the
-section address. See the comments under @samp{--change-addresses},
+section address. See the comments under @option{--change-addresses},
above. If @var{section} does not exist in the input file, a warning
-will be issued, unless @samp{--no-change-warnings} is used.
+will be issued, unless @option{--no-change-warnings} is used.
@item --change-section-vma @var{section}@{=,+,-@}@var{val}
@cindex changing section VMA
ROM, the two can be different. If @samp{=} is used, the section address
is set to @var{val}. Otherwise, @var{val} is added to or subtracted
from the section address. See the comments under
-@samp{--change-addresses}, above. If @var{section} does not exist in
+@option{--change-addresses}, above. If @var{section} does not exist in
the input file, a warning will be issued, unless
-@samp{--no-change-warnings} is used.
+@option{--no-change-warnings} is used.
@item --change-warnings
@itemx --adjust-warnings
-If @samp{--change-section-address} or @samp{--change-section-lma} or
-@samp{--change-section-vma} is used, and the named section does not
+If @option{--change-section-address} or @option{--change-section-lma} or
+@option{--change-section-vma} is used, and the named section does not
exist, issue a warning. This is the default.
@item --no-change-warnings
@itemx --no-adjust-warnings
-Do not issue a warning if @samp{--change-section-address} or
-@samp{--adjust-section-lma} or @samp{--adjust-section-vma} is used, even
+Do not issue a warning if @option{--change-section-address} or
+@option{--adjust-section-lma} or @option{--adjust-section-vma} is used, even
if the named section does not exist.
@item --set-section-flags @var{section}=@var{flags}
size of the section will be the size of the file. This option only
works on file formats which can support sections with arbitrary names.
+@item --rename-section @var{oldname}=@var{newname}[,@var{flags}]
+Rename a section from @var{oldname} to @var{newname}, optionally
+changing the section's flags to @var{flags} in the process. This has
+the advantage over usng a linker script to perform the rename in that
+the output stays as an object file and does not become a linked
+executable.
+
+This option is particularly helpful when the input format is binary,
+since this will always create a section called .data. If for example,
+you wanted instead to create a section called .rodata containing binary
+data you could use the following command line to achieve it:
+
+@smallexample
+ objcopy -I binary -O <output_format> -B <architecture> \
+ --rename-section .data=.rodata,alloc,load,readonly,data,contents \
+ <input_binary_file> <output_object_file>
+@end smallexample
+
@item --change-leading-char
Some object file formats use special characters at the start of
symbols. The most common such character is underscore, which compilers
-often add before every symbol. This option tells @code{objcopy} to
+often add before every symbol. This option tells @command{objcopy} to
change the leading character of every symbol when it converts between
object file formats. If the object file formats use the same leading
character, this option has no effect. Otherwise, it will add a
remove a leading underscore from all global symbols. This can be useful
if you want to link together objects of different file formats with
different conventions for symbol names. This is different from
-@code{--change-leading-char} because it always changes the symbol name
+@option{--change-leading-char} because it always changes the symbol name
when appropriate, regardless of the object file format of the output
file.
when one is trying link two things together for which you have no
source, and there are name collisions.
+@item --redefine-syms=@var{filename}
+Apply @option{--redefine-sym} to each symbol pair "@var{old} @var{new}"
+listed in the file @var{filename}. @var{filename} is simply a flat file,
+with one symbol pair per line. Line comments may be introduced by the hash
+character. This option may be given more than once.
+
@item --weaken
Change all global symbols in the file to be weak. This can be useful
when building an object which will be linked against other objects using
-the @code{-R} option to the linker. This option is only effective when
+the @option{-R} option to the linker. This option is only effective when
using an object file format which supports weak symbols.
@item --keep-symbols=@var{filename}
-Apply @samp{--keep-symbol} option to each symbol listed in the file
+Apply @option{--keep-symbol} option to each symbol listed in the file
@var{filename}. @var{filename} is simply a flat file, with one symbol
name per line. Line comments may be introduced by the hash character.
This option may be given more than once.
@item --strip-symbols=@var{filename}
-Apply @samp{--strip-symbol} option to each symbol listed in the file
+Apply @option{--strip-symbol} option to each symbol listed in the file
@var{filename}. @var{filename} is simply a flat file, with one symbol
name per line. Line comments may be introduced by the hash character.
This option may be given more than once.
+@item --strip-unneeded-symbols=@var{filename}
+Apply @option{--strip-unneeded-symbol} option to each symbol listed in
+the file @var{filename}. @var{filename} is simply a flat file, with one
+symbol name per line. Line comments may be introduced by the hash
+character. This option may be given more than once.
+
@item --keep-global-symbols=@var{filename}
-Apply @samp{--keep-global-symbol} option to each symbol listed in the
+Apply @option{--keep-global-symbol} option to each symbol listed in the
file @var{filename}. @var{filename} is simply a flat file, with one
symbol name per line. Line comments may be introduced by the hash
character. This option may be given more than once.
@item --localize-symbols=@var{filename}
-Apply @samp{--localize-symbol} option to each symbol listed in the file
+Apply @option{--localize-symbol} option to each symbol listed in the file
+@var{filename}. @var{filename} is simply a flat file, with one symbol
+name per line. Line comments may be introduced by the hash character.
+This option may be given more than once.
+
+@item --globalize-symbols=@var{filename}
+Apply @option{--globalize-symbol} option to each symbol listed in the file
@var{filename}. @var{filename} is simply a flat file, with one symbol
name per line. Line comments may be introduced by the hash character.
This option may be given more than once.
@item --weaken-symbols=@var{filename}
-Apply @samp{--weaken-symbol} option to each symbol listed in the file
+Apply @option{--weaken-symbol} option to each symbol listed in the file
@var{filename}. @var{filename} is simply a flat file, with one symbol
name per line. Line comments may be introduced by the hash character.
This option may be given more than once.
+@item --alt-machine-code=@var{index}
+If the output architecture has alternate machine codes, use the
+@var{index}th code instead of the default one. This is useful in case
+a machine is assigned an official code and the tool-chain adopts the
+new code, but other applications still depend on the original code
+being used.
+
+@item --writable-text
+Mark the output text as writable. This option isn't meaningful for all
+object file formats.
+
+@item --readonly-text
+Make the output text write protected. This option isn't meaningful for all
+object file formats.
+
+@item --pure
+Mark the output file as demand paged. This option isn't meaningful for all
+object file formats.
+
+@item --impure
+Mark the output file as impure. This option isn't meaningful for all
+object file formats.
+
+@item --prefix-symbols=@var{string}
+Prefix all symbols in the output file with @var{string}.
+
+@item --prefix-sections=@var{string}
+Prefix all section names in the output file with @var{string}.
+
+@item --prefix-alloc-sections=@var{string}
+Prefix all the names of all allocated sections in the output file with
+@var{string}.
+
+@item --add-gnu-debuglink=@var{path-to-file}
+Creates a .gnu_debuglink section which contains a reference to @var{path-to-file}
+and adds it to the output file.
+
+@item --keep-file-symbols
+When stripping a file, perhaps with @option{--strip-debug} or
+@option{--strip-unneeded}, retain any symbols specifying source file names,
+which would otherwise get stripped.
+
+@item --only-keep-debug
+Strip a file, removing contents of any sections that would not be
+stripped by @option{--strip-debug} and leaving the debugging sections
+intact.
+
+The intention is that this option will be used in conjunction with
+@option{--add-gnu-debuglink} to create a two part executable. One a
+stripped binary which will occupy less space in RAM and in a
+distribution and the second a debugging information file which is only
+needed if debugging abilities are required. The suggested procedure
+to create these files is as follows:
+
+@enumerate
+@item Link the executable as normal. Assuming that is is called
+@code{foo} then...
+@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
+create a file containing the debugging info.
+@item Run @code{objcopy --strip-debug foo} to create a
+stripped executable.
+@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
+to add a link to the debugging info into the stripped executable.
+@end enumerate
+
+Note - the choice of @code{.dbg} as an extension for the debug info
+file is arbitrary. Also the @code{--only-keep-debug} step is
+optional. You could instead do this:
+
+@enumerate
+@item Link the executable as normal.
+@item Copy @code{foo} to @code{foo.full}
+@item Run @code{objcopy --strip-debug foo}
+@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
+@end enumerate
+
+i.e. the file pointed to by the @option{--add-gnu-debuglink} can be the
+full executable. It does not have to be a file created by the
+@option{--only-keep-debug} switch.
+
@item -V
@itemx --version
-Show the version number of @code{objcopy}.
+Show the version number of @command{objcopy}.
@item -v
@itemx --verbose
archives, @samp{objcopy -V} lists all members of the archive.
@item --help
-Show a summary of the options to @code{objcopy}.
+Show a summary of the options to @command{objcopy}.
+
+@item --info
+Display a list showing all architectures and object formats available.
@end table
@c man end
@smallexample
@c man begin SYNOPSIS objdump
-objdump [ -a | --archive-headers ]
- [ -b @var{bfdname} | --target=@var{bfdname} ]
- [ -C | --demangle[=@var{style}] ]
- [ -d | --disassemble ]
- [ -D | --disassemble-all ]
- [ -z | --disassemble-zeroes ]
- [ -EB | -EL | --endian=@{big | little @} ]
- [ -f | --file-headers ]
- [ --file-start-context ]
- [ -g | --debugging ]
- [ -h | --section-headers | --headers ]
- [ -i | --info ]
- [ -j @var{section} | --section=@var{section} ]
- [ -l | --line-numbers ]
- [ -S | --source ]
- [ -m @var{machine} | --architecture=@var{machine} ]
- [ -M @var{options} | --disassembler-options=@var{options}]
- [ -p | --private-headers ]
- [ -r | --reloc ]
- [ -R | --dynamic-reloc ]
- [ -s | --full-contents ]
- [ -G | --stabs ]
- [ -t | --syms ]
- [ -T | --dynamic-syms ]
- [ -x | --all-headers ]
- [ -w | --wide ]
- [ --start-address=@var{address} ]
- [ --stop-address=@var{address} ]
- [ --prefix-addresses]
- [ --[no-]show-raw-insn ]
- [ --adjust-vma=@var{offset} ]
- [ -V | --version ]
- [ -H | --help ]
+objdump [@option{-a}|@option{--archive-headers}]
+ [@option{-b} @var{bfdname}|@option{--target=@var{bfdname}}]
+ [@option{-C}|@option{--demangle}[=@var{style}] ]
+ [@option{-d}|@option{--disassemble}]
+ [@option{-D}|@option{--disassemble-all}]
+ [@option{-z}|@option{--disassemble-zeroes}]
+ [@option{-EB}|@option{-EL}|@option{--endian=}@{big | little @}]
+ [@option{-f}|@option{--file-headers}]
+ [@option{--file-start-context}]
+ [@option{-g}|@option{--debugging}]
+ [@option{-e}|@option{--debugging-tags}]
+ [@option{-h}|@option{--section-headers}|@option{--headers}]
+ [@option{-i}|@option{--info}]
+ [@option{-j} @var{section}|@option{--section=}@var{section}]
+ [@option{-l}|@option{--line-numbers}]
+ [@option{-S}|@option{--source}]
+ [@option{-m} @var{machine}|@option{--architecture=}@var{machine}]
+ [@option{-M} @var{options}|@option{--disassembler-options=}@var{options}]
+ [@option{-p}|@option{--private-headers}]
+ [@option{-r}|@option{--reloc}]
+ [@option{-R}|@option{--dynamic-reloc}]
+ [@option{-s}|@option{--full-contents}]
+ [@option{-W}|@option{--dwarf}]
+ [@option{-G}|@option{--stabs}]
+ [@option{-t}|@option{--syms}]
+ [@option{-T}|@option{--dynamic-syms}]
+ [@option{-x}|@option{--all-headers}]
+ [@option{-w}|@option{--wide}]
+ [@option{--start-address=}@var{address}]
+ [@option{--stop-address=}@var{address}]
+ [@option{--prefix-addresses}]
+ [@option{--[no-]show-raw-insn}]
+ [@option{--adjust-vma=}@var{offset}]
+ [@option{--special-syms}]
+ [@option{-V}|@option{--version}]
+ [@option{-H}|@option{--help}]
@var{objfile}@dots{}
@c man end
@end smallexample
@c man begin DESCRIPTION objdump
-@code{objdump} displays information about one or more object files.
+@command{objdump} displays information about one or more object files.
The options control what particular information to display. This
information is mostly useful to programmers who are working on the
compilation tools, as opposed to programmers who just want their
program to compile and work.
@var{objfile}@dots{} are the object files to be examined. When you
-specify archives, @code{objdump} shows information on each of the member
+specify archives, @command{objdump} shows information on each of the member
object files.
@c man end
The long and short forms of options, shown here as alternatives, are
equivalent. At least one option from the list
-@samp{-a,-d,-D,-f,-g,-G,-h,-H,-p,-r,-R,-S,-t,-T,-V,-x} must be given.
+@option{-a,-d,-D,-e,-f,-g,-G,-h,-H,-p,-r,-R,-s,-S,-t,-T,-V,-x} must be given.
-@table @code
+@table @env
@item -a
@itemx --archive-header
@cindex archive headers
objdump -b oasys -m vax -h fu.o
@end example
@noindent
-displays summary information from the section headers (@samp{-h}) of
-@file{fu.o}, which is explicitly identified (@samp{-m}) as a VAX object
+displays summary information from the section headers (@option{-h}) of
+@file{fu.o}, which is explicitly identified (@option{-m}) as a VAX object
file in the format produced by Oasys compilers. You can list the
-formats available with the @samp{-i} option.
+formats available with the @option{-i} option.
@xref{Target Selection}, for more information.
@item -C
choose an appropriate demangling style for your compiler. @xref{c++filt},
for more information on demangling.
-@item -G
-@item --debugging
+@item -g
+@itemx --debugging
Display debugging information. This attempts to parse debugging
information stored in the file and print it out using a C like syntax.
Only certain types of debugging information have been implemented.
+Some other types are supported by @command{readelf -w}.
+@xref{readelf}.
+
+@item -e
+@itemx --debugging-tags
+Like @option{-g}, but the information is generated in a format compatible
+with ctags tool.
@item -d
@itemx --disassemble
@item -D
@itemx --disassemble-all
-Like @samp{-d}, but disassemble the contents of all sections, not just
+Like @option{-d}, but disassemble the contents of all sections, not just
those expected to contain instructions.
@item --prefix-addresses
When disassembling, print the complete address on each line. This is
the older disassembly format.
-@item --disassemble-zeroes
-Normally the disassembly output will skip blocks of zeroes. This
-option directs the disassembler to disassemble those blocks, just like
-any other data.
-
@item -EB
@itemx -EL
@itemx --endian=@{big|little@}
does not describe endianness information, such as S-records.
@item -f
-@itemx --file-header
+@itemx --file-headers
@cindex object file header
Display summary information from the overall header of
each of the @var{objfile} files.
@item --file-start-context
@cindex source code context
Specify that when displaying interlisted source code/disassembly
-(assumes '-S') from a file that has not yet been displayed, extend the
+(assumes @option{-S}) from a file that has not yet been displayed, extend the
context to the start of the file.
@item -h
-@itemx --section-header
-@itemx --header
+@itemx --section-headers
+@itemx --headers
@cindex section headers
Display summary information from the section headers of the
object file.
File segments may be relocated to nonstandard addresses, for example by
-using the @samp{-Ttext}, @samp{-Tdata}, or @samp{-Tbss} options to
-@code{ld}. However, some object file formats, such as a.out, do not
+using the @option{-Ttext}, @option{-Tdata}, or @option{-Tbss} options to
+@command{ld}. However, some object file formats, such as a.out, do not
store the starting address of the file segments. In those situations,
-although @code{ld} relocates the sections correctly, using @samp{objdump
+although @command{ld} relocates the sections correctly, using @samp{objdump
-h} to list the file section headers cannot show the correct addresses.
Instead, it shows the usual addresses, which are implicit for the
target.
-@item --help
-Print a summary of the options to @code{objdump} and exit.
+@item -H
+@itemx --help
+Print a summary of the options to @command{objdump} and exit.
@item -i
@itemx --info
@cindex architectures available
@cindex object formats available
Display a list showing all architectures and object formats available
-for specification with @samp{-b} or @samp{-m}.
+for specification with @option{-b} or @option{-m}.
@item -j @var{name}
@itemx --section=@var{name}
@cindex source filenames for object files
Label the display (using debugging information) with the filename and
source line numbers corresponding to the object code or relocs shown.
-Only useful with @samp{-d}, @samp{-D}, or @samp{-r}.
+Only useful with @option{-d}, @option{-D}, or @option{-r}.
@item -m @var{machine}
@itemx --architecture=@var{machine}
Specify the architecture to use when disassembling object files. This
can be useful when disassembling object files which do not describe
architecture information, such as S-records. You can list the available
-architectures with the @samp{-i} option.
+architectures with the @option{-i} option.
@item -M @var{options}
@itemx --disassembler-options=@var{options}
Pass target specific information to the disassembler. Only supported on
-some targets.
+some targets. If it is necessary to specify more than one
+disassembler option then multiple @option{-M} options can be used or
+can be placed together into a comma separated list.
If the target is an ARM architecture then this switch can be used to
select which register name set is used during disassembler. Specifying
-@samp{-M reg-name-std} (the default) will select the register names as
+@option{-M reg-names-std} (the default) will select the register names as
used in ARM's instruction set documentation, but with register 13 called
'sp', register 14 called 'lr' and register 15 called 'pc'. Specifying
-@samp{-M reg-names-apcs} will select the name set used by the ARM
-Procedure Call Standard, whilst specifying @samp{-M reg-names-raw} will
+@option{-M reg-names-apcs} will select the name set used by the ARM
+Procedure Call Standard, whilst specifying @option{-M reg-names-raw} will
just use @samp{r} followed by the register number.
There are also two variants on the APCS register naming scheme enabled
-by @samp{-M reg-names-atpcs} and @samp{-M reg-names-special-atpcs} which
-use the ARM/Thumb Procedure Call Standard naming conventions. (Eiuther
-with the normal register name sor the special register names).
+by @option{-M reg-names-atpcs} and @option{-M reg-names-special-atpcs} which
+use the ARM/Thumb Procedure Call Standard naming conventions. (Either
+with the normal register names or the special register names).
This option can also be used for ARM architectures to force the
-disassembler to interpret all instructions as THUMB instructions by
-using the switch @samp{--disassembler-options=force-thumb}. This can be
+disassembler to interpret all instructions as Thumb instructions by
+using the switch @option{--disassembler-options=force-thumb}. This can be
useful when attempting to disassemble thumb code produced by other
compilers.
+For the x86, some of the options duplicate functions of the @option{-m}
+switch, but allow finer grained control. Multiple selections from the
+following may be specified as a comma separated string.
+@option{x86-64}, @option{i386} and @option{i8086} select disassembly for
+the given architecture. @option{intel} and @option{att} select between
+intel syntax mode and AT&T syntax mode. @option{addr32},
+@option{addr16}, @option{data32} and @option{data16} specify the default
+address size and operand size. These four options will be overridden if
+@option{x86-64}, @option{i386} or @option{i8086} appear later in the
+option string. Lastly, @option{suffix}, when in AT&T mode,
+instructs the disassembler to print a mnemonic suffix even when the
+suffix could be inferred by the operands.
+
+For PPC, @option{booke}, @option{booke32} and @option{booke64} select
+disassembly of BookE instructions. @option{32} and @option{64} select
+PowerPC and PowerPC64 disassembly, respectively. @option{e300} selects
+disassembly for the e300 family.
+
+For MIPS, this option controls the printing of instruction mneumonic
+names and register names in disassembled instructions. Multiple
+selections from the following may be specified as a comma separated
+string, and invalid options are ignored:
+
+@table @code
+@item no-aliases
+Print the 'raw' instruction mneumonic instead of some pseudo
+instruction mneumonic. I.E. print 'daddu' or 'or' instead of 'move',
+'sll' instead of 'nop', etc.
+
+@item gpr-names=@var{ABI}
+Print GPR (general-purpose register) names as appropriate
+for the specified ABI. By default, GPR names are selected according to
+the ABI of the binary being disassembled.
+
+@item fpr-names=@var{ABI}
+Print FPR (floating-point register) names as
+appropriate for the specified ABI. By default, FPR numbers are printed
+rather than names.
+
+@item cp0-names=@var{ARCH}
+Print CP0 (system control coprocessor; coprocessor 0) register names
+as appropriate for the CPU or architecture specified by
+@var{ARCH}. By default, CP0 register names are selected according to
+the architecture and CPU of the binary being disassembled.
+
+@item hwr-names=@var{ARCH}
+Print HWR (hardware register, used by the @code{rdhwr} instruction) names
+as appropriate for the CPU or architecture specified by
+@var{ARCH}. By default, HWR names are selected according to
+the architecture and CPU of the binary being disassembled.
+
+@item reg-names=@var{ABI}
+Print GPR and FPR names as appropriate for the selected ABI.
+
+@item reg-names=@var{ARCH}
+Print CPU-specific register names (CP0 register and HWR names)
+as appropriate for the selected CPU or architecture.
+@end table
+
+For any of the options listed above, @var{ABI} or
+@var{ARCH} may be specified as @samp{numeric} to have numbers printed
+rather than names, for the selected types of registers.
+You can list the available values of @var{ABI} and @var{ARCH} using
+the @option{--help} option.
+
+For VAX, you can specify function entry addresses with @option{-M
+entry:0xf00ba}. You can use this multiple times to properly
+disassemble VAX binary files that don't contain symbol tables (like
+ROM dumps). In these cases, the function entry mask would otherwise
+be decoded as VAX instructions, which would probably lead the the rest
+of the function being wrongly disassembled.
+
@item -p
@itemx --private-headers
Print information that is specific to the object file format. The exact
@item -r
@itemx --reloc
@cindex relocation entries, in object file
-Print the relocation entries of the file. If used with @samp{-d} or
-@samp{-D}, the relocations are printed interspersed with the
+Print the relocation entries of the file. If used with @option{-d} or
+@option{-D}, the relocations are printed interspersed with the
disassembly.
@item -R
@itemx --full-contents
@cindex sections, full contents
@cindex object file sections
-Display the full contents of any sections requested.
+Display the full contents of any sections requested. By default all
+non-empty sections are displayed.
@item -S
@itemx --source
@cindex source disassembly
@cindex disassembly, with source
Display source code intermixed with disassembly, if possible. Implies
-@samp{-d}.
+@option{-d}.
@item --show-raw-insn
When disassembling instructions, print the instruction in hex as well as
in symbolic form. This is the default except when
-@code{--prefix-addresses} is used.
+@option{--prefix-addresses} is used.
@item --no-show-raw-insn
When disassembling instructions, do not print the instruction bytes.
-This is the default when @code{--prefix-addresses} is used.
+This is the default when @option{--prefix-addresses} is used.
+
+@item -W
+@itemx --dwarf
+@cindex DWARF
+@cindex debug symbols
+Displays the contents of the DWARF debug sections in the file, if any
+are present.
@item -G
-@item --stabs
+@itemx --stabs
@cindex stab
@cindex .stab
@cindex debug symbols
ELF file. This is only useful on systems (such as Solaris 2.0) in which
@code{.stab} debugging symbol-table entries are carried in an ELF
section. In most other file formats, debugging symbol-table entries are
-interleaved with linkage symbols, and are visible in the @samp{--syms}
+interleaved with linkage symbols, and are visible in the @option{--syms}
output.
@ifclear man
For more information on stabs symbols, see @ref{Top,Stabs,Stabs
@item --start-address=@var{address}
@cindex start-address
Start displaying data at the specified address. This affects the output
-of the @code{-d}, @code{-r} and @code{-s} options.
+of the @option{-d}, @option{-r} and @option{-s} options.
@item --stop-address=@var{address}
@cindex stop-address
Stop displaying data at the specified address. This affects the output
-of the @code{-d}, @code{-r} and @code{-s} options.
+of the @option{-d}, @option{-r} and @option{-s} options.
@item -t
@itemx --syms
Print the dynamic symbol table entries of the file. This is only
meaningful for dynamic objects, such as certain types of shared
libraries. This is similar to the information provided by the @samp{nm}
-program when given the @samp{-D} (@samp{--dynamic}) option.
+program when given the @option{-D} (@option{--dynamic}) option.
-@item --version
-Print the version number of @code{objdump} and exit.
+@item --special-syms
+When displaying symbols include those which the target considers to be
+special in some way and which would not normally be of interest to the
+user.
+
+@item -V
+@itemx --version
+Print the version number of @command{objdump} and exit.
@item -x
-@itemx --all-header
+@itemx --all-headers
@cindex all header information, object file
@cindex header information, all
Display all available header information, including the symbol table and
-relocation entries. Using @samp{-x} is equivalent to specifying all of
-@samp{-a -f -h -r -t}.
+relocation entries. Using @option{-x} is equivalent to specifying all of
+@option{-a -f -h -p -r -t}.
@item -w
@itemx --wide
@cindex wide output, printing
Format some lines for output devices that have more than 80 columns.
+Also do not truncate symbol names when they are displayed.
+
+@item -z
+@itemx --disassemble-zeroes
+Normally the disassembly output will skip blocks of zeroes. This
+option directs the disassembler to disassemble those blocks, just like
+any other data.
@end table
@c man end
@smallexample
@c man begin SYNOPSIS ranlib
-ranlib [-vV] @var{archive}
+ranlib [@option{-vV}] @var{archive}
@c man end
@end smallexample
@c man begin DESCRIPTION ranlib
-@code{ranlib} generates an index to the contents of an archive and
+@command{ranlib} generates an index to the contents of an archive and
stores it in the archive. The index lists each symbol defined by a
member of an archive that is a relocatable object file.
allows routines in the library to call each other without regard to
their placement in the archive.
-The @sc{gnu} @code{ranlib} program is another form of @sc{gnu} @code{ar}; running
-@code{ranlib} is completely equivalent to executing @samp{ar -s}.
+The @sc{gnu} @command{ranlib} program is another form of @sc{gnu} @command{ar}; running
+@command{ranlib} is completely equivalent to executing @samp{ar -s}.
@xref{ar}.
@c man end
@c man begin OPTIONS ranlib
-@table @code
+@table @env
@item -v
@itemx -V
@itemx --version
-Show the version number of @code{ranlib}.
+Show the version number of @command{ranlib}.
@end table
@c man end
@smallexample
@c man begin SYNOPSIS size
-size [ -A | -B | --format=@var{compatibility} ]
- [ --help ] [ -d | -o | -x | --radix=@var{number} ]
- [ --target=@var{bfdname} ] [ -V | --version ]
- [ @var{objfile}@dots{} ]
+size [@option{-A}|@option{-B}|@option{--format=}@var{compatibility}]
+ [@option{--help}]
+ [@option{-d}|@option{-o}|@option{-x}|@option{--radix=}@var{number}]
+ [@option{-t}|@option{--totals}]
+ [@option{--target=}@var{bfdname}] [@option{-V}|@option{--version}]
+ [@var{objfile}@dots{}]
@c man end
@end smallexample
@c man begin DESCRIPTION size
-The @sc{gnu} @code{size} utility lists the section sizes---and the total
+The @sc{gnu} @command{size} utility lists the section sizes---and the total
size---for each of the object or archive files @var{objfile} in its
argument list. By default, one line of output is generated for each
object file or each module in an archive.
The command line options have the following meanings:
-@table @code
+@table @env
@item -A
@itemx -B
@itemx --format=@var{compatibility}
-@cindex @code{size} display format
+@cindex @command{size} display format
Using one of these options, you can choose whether the output from @sc{gnu}
-@code{size} resembles output from System V @code{size} (using @samp{-A},
-or @samp{--format=sysv}), or Berkeley @code{size} (using @samp{-B}, or
-@samp{--format=berkeley}). The default is the one-line format similar to
+@command{size} resembles output from System V @command{size} (using @option{-A},
+or @option{--format=sysv}), or Berkeley @command{size} (using @option{-B}, or
+@option{--format=berkeley}). The default is the one-line format similar to
Berkeley's.
@c Bonus for doc-source readers: you can also say --format=strange (or
@c anything else that starts with 's') for sysv, and --format=boring (or
@c anything else that starts with 'b') for Berkeley.
Here is an example of the Berkeley (default) format of output from
-@code{size}:
+@command{size}:
@smallexample
$ size --format=Berkeley ranlib size
text data bss dec hex filename
@itemx -o
@itemx -x
@itemx --radix=@var{number}
-@cindex @code{size} number format
+@cindex @command{size} number format
@cindex radix for section sizes
Using one of these options, you can control whether the size of each
-section is given in decimal (@samp{-d}, or @samp{--radix=10}); octal
-(@samp{-o}, or @samp{--radix=8}); or hexadecimal (@samp{-x}, or
-@samp{--radix=16}). In @samp{--radix=@var{number}}, only the three
+section is given in decimal (@option{-d}, or @option{--radix=10}); octal
+(@option{-o}, or @option{--radix=8}); or hexadecimal (@option{-x}, or
+@option{--radix=16}). In @option{--radix=@var{number}}, only the three
values (8, 10, 16) are supported. The total size is always given in two
-radices; decimal and hexadecimal for @samp{-d} or @samp{-x} output, or
-octal and hexadecimal if you're using @samp{-o}.
+radices; decimal and hexadecimal for @option{-d} or @option{-x} output, or
+octal and hexadecimal if you're using @option{-o}.
+
+@item -t
+@itemx --totals
+Show totals of all objects listed (Berkeley format listing mode only).
@item --target=@var{bfdname}
@cindex object code format
Specify that the object-code format for @var{objfile} is
-@var{bfdname}. This option may not be necessary; @code{size} can
+@var{bfdname}. This option may not be necessary; @command{size} can
automatically recognize many formats.
@xref{Target Selection}, for more information.
@item -V
@itemx --version
-Display the version number of @code{size}.
+Display the version number of @command{size}.
@end table
@c man end
@smallexample
@c man begin SYNOPSIS strings
-strings [-afov] [-@var{min-len}] [-n @var{min-len}] [-t @var{radix}] [-]
- [--all] [--print-file-name] [--bytes=@var{min-len}]
- [--radix=@var{radix}] [--target=@var{bfdname}]
- [--help] [--version] @var{file}@dots{}
+strings [@option{-afov}] [@option{-}@var{min-len}]
+ [@option{-n} @var{min-len}] [@option{--bytes=}@var{min-len}]
+ [@option{-t} @var{radix}] [@option{--radix=}@var{radix}]
+ [@option{-e} @var{encoding}] [@option{--encoding=}@var{encoding}]
+ [@option{-}] [@option{--all}] [@option{--print-file-name}]
+ [@option{--target=}@var{bfdname}]
+ [@option{--help}] [@option{--version}] @var{file}@dots{}
@c man end
@end smallexample
@c man begin DESCRIPTION strings
-For each @var{file} given, @sc{gnu} @code{strings} prints the printable
+For each @var{file} given, @sc{gnu} @command{strings} prints the printable
character sequences that are at least 4 characters long (or the number
given with the options below) and are followed by an unprintable
character. By default, it only prints the strings from the initialized
and loaded sections of object files; for other types of files, it prints
the strings from the whole file.
-@code{strings} is mainly useful for determining the contents of non-text
+@command{strings} is mainly useful for determining the contents of non-text
files.
@c man end
@c man begin OPTIONS strings
-@table @code
+@table @env
@item -a
@itemx --all
@itemx -
long, instead of the default 4.
@item -o
-Like @samp{-t o}. Some other versions of @code{strings} have @samp{-o}
+Like @samp{-t o}. Some other versions of @command{strings} have @option{-o}
act like @samp{-t d} instead. Since we can not be compatible with both
ways, we simply chose one.
character argument specifies the radix of the offset---@samp{o} for
octal, @samp{x} for hexadecimal, or @samp{d} for decimal.
+@item -e @var{encoding}
+@itemx --encoding=@var{encoding}
+Select the character encoding of the strings that are to be found.
+Possible values for @var{encoding} are: @samp{s} = single-7-bit-byte
+characters (ASCII, ISO 8859, etc., default), @samp{S} =
+single-8-bit-byte characters, @samp{b} = 16-bit bigendian, @samp{l} =
+16-bit littleendian, @samp{B} = 32-bit bigendian, @samp{L} = 32-bit
+littleendian. Useful for finding wide character strings.
+
@item --target=@var{bfdname}
@cindex object code format
Specify an object code format other than your system's default format.
@smallexample
@c man begin SYNOPSIS strip
-strip [ -F @var{bfdname} | --target=@var{bfdname} ]
- [ -I @var{bfdname} | --input-target=@var{bfdname} ]
- [ -O @var{bfdname} | --output-target=@var{bfdname} ]
- [ -s | --strip-all ] [ -S | -g | --strip-debug ]
- [ -K @var{symbolname} | --keep-symbol=@var{symbolname} ]
- [ -N @var{symbolname} | --strip-symbol=@var{symbolname} ]
- [ -x | --discard-all ] [ -X | --discard-locals ]
- [ -R @var{sectionname} | --remove-section=@var{sectionname} ]
- [ -o @var{file} ] [ -p | --preserve-dates ]
- [ -v | --verbose ] [ -V | --version ] [ --help ]
+strip [@option{-F} @var{bfdname} |@option{--target=}@var{bfdname}]
+ [@option{-I} @var{bfdname} |@option{--input-target=}@var{bfdname}]
+ [@option{-O} @var{bfdname} |@option{--output-target=}@var{bfdname}]
+ [@option{-s}|@option{--strip-all}]
+ [@option{-S}|@option{-g}|@option{-d}|@option{--strip-debug}]
+ [@option{-K} @var{symbolname} |@option{--keep-symbol=}@var{symbolname}]
+ [@option{-N} @var{symbolname} |@option{--strip-symbol=}@var{symbolname}]
+ [@option{-w}|@option{--wildcard}]
+ [@option{-x}|@option{--discard-all}] [@option{-X} |@option{--discard-locals}]
+ [@option{-R} @var{sectionname} |@option{--remove-section=}@var{sectionname}]
+ [@option{-o} @var{file}] [@option{-p}|@option{--preserve-dates}]
+ [@option{--keep-file-symbols}]
+ [@option{--only-keep-debug}]
+ [@option{-v} |@option{--verbose}] [@option{-V}|@option{--version}]
+ [@option{--help}] [@option{--info}]
@var{objfile}@dots{}
@c man end
@end smallexample
@c man begin DESCRIPTION strip
-@sc{gnu} @code{strip} discards all symbols from object files
+@sc{gnu} @command{strip} discards all symbols from object files
@var{objfile}. The list of object files may include archives.
At least one object file must be given.
-@code{strip} modifies the files named in its argument,
+@command{strip} modifies the files named in its argument,
rather than writing modified copies under different names.
@c man end
@c man begin OPTIONS strip
-@table @code
+@table @env
@item -F @var{bfdname}
@itemx --target=@var{bfdname}
Treat the original @var{objfile} as a file with the object
@xref{Target Selection}, for more information.
@item --help
-Show a summary of the options to @code{strip} and exit.
+Show a summary of the options to @command{strip} and exit.
+
+@item --info
+Display a list showing all architectures and object formats available.
-@item -I @var{bfdname}
+@item -I @var{bfdname}
@itemx --input-target=@var{bfdname}
Treat the original @var{objfile} as a file with the object
code format @var{bfdname}.
@item -g
@itemx -S
+@itemx -d
@itemx --strip-debug
Remove debugging symbols only.
@item -K @var{symbolname}
@itemx --keep-symbol=@var{symbolname}
-Keep only symbol @var{symbolname} from the source file. This option may
-be given more than once.
+When stripping symbols, keep symbol @var{symbolname} even if it would
+normally be stripped. This option may be given more than once.
@item -N @var{symbolname}
@itemx --strip-symbol=@var{symbolname}
Remove symbol @var{symbolname} from the source file. This option may be
given more than once, and may be combined with strip options other than
-@code{-K}.
+@option{-K}.
@item -o @var{file}
Put the stripped output in @var{file}, rather than replacing the
@itemx --preserve-dates
Preserve the access and modification dates of the file.
+@item -w
+@itemx --wildcard
+Permit regular expressions in @var{symbolname}s used in other command
+line options. The question mark (?), asterisk (*), backslash (\) and
+square brackets ([]) operators can be used anywhere in the symbol
+name. If the first character of the symbol name is the exclamation
+point (!) then the sense of the switch is reversed for that symbol.
+For example:
+
+@smallexample
+ -w -K !foo -K fo*
+@end smallexample
+
+would cause strip to only keep symbols that start with the letters
+``fo'', but to discard the symbol ``foo''.
+
@item -x
@itemx --discard-all
Remove non-global symbols.
Remove compiler-generated local symbols.
(These usually start with @samp{L} or @samp{.}.)
+@item --keep-file-symbols
+When stripping a file, perhaps with @option{--strip-debug} or
+@option{--strip-unneeded}, retain any symbols specifying source file names,
+which would otherwise get stripped.
+
+@item --only-keep-debug
+Strip a file, removing any sections that would be stripped by
+@option{--strip-debug} and leaving the debugging sections.
+
+The intention is that this option will be used in conjunction with
+@option{--add-gnu-debuglink} to create a two part executable. One a
+stripped binary which will occupy less space in RAM and in a
+distribution and the second a debugging information file which is only
+needed if debugging abilities are required. The suggested procedure
+to create these files is as follows:
+
+@enumerate
+@item Link the executable as normal. Assuming that is is called
+@code{foo} then...
+@item Run @code{objcopy --only-keep-debug foo foo.dbg} to
+create a file containing the debugging info.
+@item Run @code{objcopy --strip-debug foo} to create a
+stripped executable.
+@item Run @code{objcopy --add-gnu-debuglink=foo.dbg foo}
+to add a link to the debugging info into the stripped executable.
+@end enumerate
+
+Note - the choice of @code{.dbg} as an extension for the debug info
+file is arbitrary. Also the @code{--only-keep-debug} step is
+optional. You could instead do this:
+
+@enumerate
+@item Link the executable as normal.
+@item Copy @code{foo} to @code{foo.full}
+@item Run @code{strip --strip-debug foo}
+@item Run @code{objcopy --add-gnu-debuglink=foo.full foo}
+@end enumerate
+
+ie the file pointed to by the @option{--add-gnu-debuglink} can be the
+full executable. It does not have to be a file created by the
+@option{--only-keep-debug} switch.
+
@item -V
@itemx --version
-Show the version number for @code{strip}.
+Show the version number for @command{strip}.
@item -v
@itemx --verbose
@smallexample
@c man begin SYNOPSIS cxxfilt
-c++filt [ -_ | --strip-underscores ]
- [ -j | --java ]
- [ -n | --no-strip-underscores ]
- [ -s @var{format} | --format=@var{format} ]
- [ --help ] [ --version ] [ @var{symbol}@dots{} ]
+c++filt [@option{-_}|@option{--strip-underscores}]
+ [@option{-n}|@option{--no-strip-underscores}]
+ [@option{-p}|@option{--no-params}]
+ [@option{-t}|@option{--types}]
+ [@option{-i}|@option{--no-verbose}]
+ [@option{-s} @var{format}|@option{--format=}@var{format}]
+ [@option{--help}] [@option{--version}] [@var{symbol}@dots{}]
@c man end
@end smallexample
@c man begin DESCRIPTION cxxfilt
@kindex cxxfilt
-The C++ and Java languages provides function overloading, which means
-that you can write many functions with the same name (providing each
-takes parameters of different types). All C++ and Java function names
-are encoded into a low-level assembly label (this process is known as
-@dfn{mangling}). The @code{c++filt}
-@footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
-MS-DOS this program is named @code{cxxfilt}.}
+The C++ and Java languages provide function overloading, which means
+that you can write many functions with the same name, providing that
+each function takes parameters of different types. In order to be
+able to distinguish these similarly named functions C++ and Java
+encode them into a low-level assembler name which uniquely identifies
+each different version. This process is known as @dfn{mangling}. The
+@command{c++filt}
+@footnote{MS-DOS does not allow @kbd{+} characters in file names, so on
+MS-DOS this program is named @command{CXXFILT}.}
program does the inverse mapping: it decodes (@dfn{demangles}) low-level
-names into user-level names so that the linker can keep these overloaded
-functions from clashing.
+names into user-level names so that they can be read.
Every alphanumeric word (consisting of letters, digits, underscores,
-dollars, or periods) seen in the input is a potential label. If the
-label decodes into a C++ name, the C++ name replaces the low-level
-name in the output.
+dollars, or periods) seen in the input is a potential mangled name.
+If the name decodes into a C++ name, the C++ name replaces the
+low-level name in the output, otherwise the original word is output.
+In this way you can pass an entire assembler source file, containing
+mangled names, through @command{c++filt} and see the same source file
+containing demangled names.
-You can use @code{c++filt} to decipher individual symbols:
+You can also use @command{c++filt} to decipher individual symbols by
+passing them on the command line:
@example
c++filt @var{symbol}
@end example
-If no @var{symbol} arguments are given, @code{c++filt} reads symbol
-names from the standard input and writes the demangled names to the
-standard output. All results are printed on the standard output.
+If no @var{symbol} arguments are given, @command{c++filt} reads symbol
+names from the standard input instead. All the results are printed on
+the standard output. The difference between reading names from the
+command line versus reading names from the standard input is that
+command line arguments are expected to be just mangled names and no
+checking is performed to seperate them from surrounding text. Thus
+for example:
+
+@smallexample
+c++filt -n _Z1fv
+@end smallexample
+
+will work and demangle the name to ``f()'' whereas:
+
+@smallexample
+c++filt -n _Z1fv,
+@end smallexample
+
+will not work. (Note the extra comma at the end of the mangled
+name which makes it invalid). This command however will work:
+
+@smallexample
+echo _Z1fv, | c++filt -n
+@end smallexample
+
+and will display ``f(),'' ie the demangled name followed by a
+trailing comma. This behaviour is because when the names are read
+from the standard input it is expected that they might be part of an
+assembler source file where there might be extra, extraneous
+characters trailing after a mangled name. eg:
+
+@smallexample
+ .type _Z1fv, @@function
+@end smallexample
@c man end
@c man begin OPTIONS cxxfilt
-@table @code
+@table @env
@item -_
@itemx --strip-underscores
On some systems, both the C and C++ compilers put an underscore in front
of every name. For example, the C name @code{foo} gets the low-level
name @code{_foo}. This option removes the initial underscore. Whether
-@code{c++filt} removes the underscore by default is target dependent.
+@command{c++filt} removes the underscore by default is target dependent.
@item -j
@itemx --java
@itemx --no-strip-underscores
Do not remove the initial underscore.
+@item -p
+@itemx --no-params
+When demangling the name of a function, do not display the types of
+the function's parameters.
+
+@item -t
+@itemx --types
+Attempt to demangle types as well as function names. This is disabled
+by default since mangled types are normally only used internally in
+the compiler, and they can be confused with non-mangled names. eg
+a function called ``a'' treated as a mangled type name would be
+demangled to ``signed char''.
+
+@item -i
+@itemx --no-verbose
+Do not include implementation details (if any) in the demangled
+output.
+
@item -s @var{format}
@itemx --format=@var{format}
-@sc{gnu} @code{nm} can decode three different methods of mangling, used by
-different C++ compilers. The argument to this option selects which
+@command{c++filt} can decode various methods of mangling, used by
+different compilers. The argument to this option selects which
method it uses:
@table @code
+@item auto
+Automatic selection based on executable (the default method)
@item gnu
-the one used by the @sc{gnu} compiler (the default method)
+the one used by the @sc{gnu} C++ compiler (g++)
@item lucid
-the one used by the Lucid compiler
+the one used by the Lucid compiler (lcc)
@item arm
the one specified by the C++ Annotated Reference Manual
@item hp
-the one used by the HP compiler
+the one used by the HP compiler (aCC)
@item edg
the one used by the EDG compiler
-@item gnu-new-abi
-the one used by the @sc{gnu} compiler with the new ABI.
+@item gnu-v3
+the one used by the @sc{gnu} C++ compiler (g++) with the V3 ABI.
+@item java
+the one used by the @sc{gnu} Java compiler (gcj)
+@item gnat
+the one used by the @sc{gnu} Ada compiler (GNAT).
@end table
@item --help
-Print a summary of the options to @code{c++filt} and exit.
+Print a summary of the options to @command{c++filt} and exit.
@item --version
-Print the version number of @code{c++filt} and exit.
+Print the version number of @command{c++filt} and exit.
@end table
@c man end
@end ignore
@quotation
-@emph{Warning:} @code{c++filt} is a new utility, and the details of its
+@emph{Warning:} @command{c++filt} is a new utility, and the details of its
user interface are subject to change in future releases. In particular,
a command-line option may be required in the the future to decode a name
passed as an argument on the command line; in other words,
@smallexample
@c man begin SYNOPSIS addr2line
-addr2line [ -b @var{bfdname} | --target=@var{bfdname} ]
- [ -C | --demangle[=@var{style} ]
- [ -e @var{filename} | --exe=@var{filename} ]
- [ -f | --functions ] [ -s | --basename ]
- [ -H | --help ] [ -V | --version ]
- [ addr addr ... ]
+addr2line [@option{-b} @var{bfdname}|@option{--target=}@var{bfdname}]
+ [@option{-C}|@option{--demangle}[=@var{style}]]
+ [@option{-e} @var{filename}|@option{--exe=}@var{filename}]
+ [@option{-f}|@option{--functions}] [@option{-s}|@option{--basename}]
+ [@option{-i}|@option{--inlines}]
+ [@option{-H}|@option{--help}] [@option{-V}|@option{--version}]
+ [addr addr @dots{}]
@c man end
@end smallexample
@c man begin DESCRIPTION addr2line
-@code{addr2line} translates program addresses into file names and line
+@command{addr2line} translates program addresses into file names and line
numbers. Given an address and an executable, it uses the debugging
information in the executable to figure out which file name and line
number are associated with a given address.
-The executable to use is specified with the @code{-e} option. The
+The executable to use is specified with the @option{-e} option. The
default is the file @file{a.out}.
-@code{addr2line} has two modes of operation.
+@command{addr2line} has two modes of operation.
In the first, hexadecimal addresses are specified on the command line,
-and @code{addr2line} displays the file name and line number for each
+and @command{addr2line} displays the file name and line number for each
address.
-In the second, @code{addr2line} reads hexadecimal addresses from
+In the second, @command{addr2line} reads hexadecimal addresses from
standard input, and prints the file name and line number for each
-address on standard output. In this mode, @code{addr2line} may be used
+address on standard output. In this mode, @command{addr2line} may be used
in a pipe to convert dynamically chosen addresses.
The format of the output is @samp{FILENAME:LINENO}. The file name and
line number for each address is printed on a separate line. If the
-@code{-f} option is used, then each @samp{FILENAME:LINENO} line is
+@command{-f} option is used, then each @samp{FILENAME:LINENO} line is
preceded by a @samp{FUNCTIONNAME} line which is the name of the function
containing the address.
If the file name or function name can not be determined,
-@code{addr2line} will print two question marks in their place. If the
-line number can not be determined, @code{addr2line} will print 0.
+@command{addr2line} will print two question marks in their place. If the
+line number can not be determined, @command{addr2line} will print 0.
@c man end
The long and short forms of options, shown here as alternatives, are
equivalent.
-@table @code
+@table @env
@item -b @var{bfdname}
@itemx --target=@var{bfdname}
@cindex object code format
@item -s
@itemx --basenames
Display only the base of each file name.
+
+@item -i
+@itemx --inlines
+If the address belongs to a function that was inlined, the source
+information for all enclosing scopes back to the first non-inlined
+function will also be printed. For example, if @code{main} inlines
+@code{callee1} which inlines @code{callee2}, and address is from
+@code{callee2}, the source information for @code{callee1} and @code{main}
+will also be printed.
@end table
@c man end
@node nlmconv
@chapter nlmconv
-@code{nlmconv} converts a relocatable object file into a NetWare
+@command{nlmconv} converts a relocatable object file into a NetWare
Loadable Module.
@ignore
-@code{nlmconv} currently works with @samp{i386} object
+@command{nlmconv} currently works with @samp{i386} object
files in @code{coff}, @sc{elf}, or @code{a.out} format, and @sc{SPARC}
object files in @sc{elf}, or @code{a.out} format@footnote{
-@code{nlmconv} should work with any @samp{i386} or @sc{sparc} object
+@command{nlmconv} should work with any @samp{i386} or @sc{sparc} object
format in the Binary File Descriptor library. It has only been tested
with the above formats.}.
@end ignore
@quotation
-@emph{Warning:} @code{nlmconv} is not always built as part of the binary
+@emph{Warning:} @command{nlmconv} is not always built as part of the binary
utilities, since it is only useful for NLM targets.
@end quotation
@smallexample
@c man begin SYNOPSIS nlmconv
-nlmconv [ -I @var{bfdname} | --input-target=@var{bfdname} ]
- [ -O @var{bfdname} | --output-target=@var{bfdname} ]
- [ -T @var{headerfile} | --header-file=@var{headerfile} ]
- [ -d | --debug] [ -l @var{linker} | --linker=@var{linker} ]
- [ -h | --help ] [ -V | --version ]
+nlmconv [@option{-I} @var{bfdname}|@option{--input-target=}@var{bfdname}]
+ [@option{-O} @var{bfdname}|@option{--output-target=}@var{bfdname}]
+ [@option{-T} @var{headerfile}|@option{--header-file=}@var{headerfile}]
+ [@option{-d}|@option{--debug}] [@option{-l} @var{linker}|@option{--linker=}@var{linker}]
+ [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
@var{infile} @var{outfile}
@c man end
@end smallexample
@c man begin DESCRIPTION nlmconv
-@code{nlmconv} converts the relocatable @samp{i386} object file
+@command{nlmconv} converts the relocatable @samp{i386} object file
@var{infile} into the NetWare Loadable Module @var{outfile}, optionally
reading @var{headerfile} for NLM header information. For instructions
on writing the NLM command file language used in header files, see the
@samp{linkers} section, @samp{NLMLINK} in particular, of the @cite{NLM
Development and Tools Overview}, which is part of the NLM Software
Developer's Kit (``NLM SDK''), available from Novell, Inc.
-@code{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
+@command{nlmconv} uses the @sc{gnu} Binary File Descriptor library to read
@var{infile};
@ifclear man
see @ref{BFD,,BFD,ld.info,Using LD}, for more information.
@end ifclear
-@code{nlmconv} can perform a link step. In other words, you can list
+@command{nlmconv} can perform a link step. In other words, you can list
more than one object file for input if you list them in the definitions
file (rather than simply specifying one input file on the command line).
-In this case, @code{nlmconv} calls the linker for you.
+In this case, @command{nlmconv} calls the linker for you.
@c man end
@c man begin OPTIONS nlmconv
-@table @code
+@table @env
@item -I @var{bfdname}
@itemx --input-target=@var{bfdname}
-Object format of the input file. @code{nlmconv} can usually determine
+Object format of the input file. @command{nlmconv} can usually determine
the format of a given file (so no default is necessary).
@xref{Target Selection}, for more information.
@item -O @var{bfdname}
@itemx --output-target=@var{bfdname}
-Object format of the output file. @code{nlmconv} infers the output
+Object format of the output file. @command{nlmconv} infers the output
format based on the input format, e.g. for a @samp{i386} input file the
output format is @samp{nlm32-i386}.
@xref{Target Selection}, for more information.
@item -d
@itemx --debug
-Displays (on standard error) the linker command line used by @code{nlmconv}.
+Displays (on standard error) the linker command line used by @command{nlmconv}.
@item -l @var{linker}
@itemx --linker=@var{linker}
@item -V
@itemx --version
-Prints the version number for @code{nlmconv}.
+Prints the version number for @command{nlmconv}.
@end table
@c man end
@node windres
@chapter windres
-@code{windres} may be used to manipulate Windows resources.
+@command{windres} may be used to manipulate Windows resources.
@quotation
-@emph{Warning:} @code{windres} is not always built as part of the binary
+@emph{Warning:} @command{windres} is not always built as part of the binary
utilities, since it is only useful for Windows targets.
@end quotation
@c man begin DESCRIPTION windres
-@code{windres} reads resources from an input file and copies them into
+@command{windres} reads resources from an input file and copies them into
an output file. Either file may be in one of three formats:
@table @code
The exact description of these different formats is available in
documentation from Microsoft.
-When @code{windres} converts from the @code{rc} format to the @code{res}
+When @command{windres} converts from the @code{rc} format to the @code{res}
format, it is acting like the Windows Resource Compiler. When
-@code{windres} converts from the @code{res} format to the @code{coff}
+@command{windres} converts from the @code{res} format to the @code{coff}
format, it is acting like the Windows @code{CVTRES} program.
-When @code{windres} generates an @code{rc} file, the output is similar
+When @command{windres} generates an @code{rc} file, the output is similar
but not identical to the format expected for the input. When an input
@code{rc} file refers to an external filename, an output @code{rc} file
will instead include the file contents.
-If the input or output format is not specified, @code{windres} will
+If the input or output format is not specified, @command{windres} will
guess based on the file name, or, for the input file, the file contents.
A file with an extension of @file{.rc} will be treated as an @code{rc}
file, a file with an extension of @file{.res} will be treated as a
@code{res} file, and a file with an extension of @file{.o} or
@file{.exe} will be treated as a @code{coff} file.
-If no output file is specified, @code{windres} will print the resources
+If no output file is specified, @command{windres} will print the resources
in @code{rc} format to standard output.
-The normal use is for you to write an @code{rc} file, use @code{windres}
+The normal use is for you to write an @code{rc} file, use @command{windres}
to convert it to a COFF object file, and then link the COFF file into
your application. This will make the resources described in the
@code{rc} file available to Windows.
@c man begin OPTIONS windres
-@table @code
+@table @env
@item -i @var{filename}
@itemx --input @var{filename}
The name of the input file. If this option is not used, then
-@code{windres} will use the first non-option argument as the input file
-name. If there are no non-option arguments, then @code{windres} will
-read from standard input. @code{windres} can not read a COFF file from
+@command{windres} will use the first non-option argument as the input file
+name. If there are no non-option arguments, then @command{windres} will
+read from standard input. @command{windres} can not read a COFF file from
standard input.
@item -o @var{filename}
@itemx --output @var{filename}
The name of the output file. If this option is not used, then
-@code{windres} will use the first non-option argument, after any used
+@command{windres} will use the first non-option argument, after any used
for the input file name, as the output file name. If there is no
-non-option argument, then @code{windres} will write to standard output.
-@code{windres} can not write a COFF file to standard output.
+non-option argument, then @command{windres} will write to standard output.
+@command{windres} can not write a COFF file to standard output. Note,
+for compatability with @command{rc} the option @option{-fo} is also
+accepted, but its use is not recommended.
-@item -I @var{format}
+@item -J @var{format}
@itemx --input-format @var{format}
The input format to read. @var{format} may be @samp{res}, @samp{rc}, or
-@samp{coff}. If no input format is specified, @code{windres} will
+@samp{coff}. If no input format is specified, @command{windres} will
guess, as described above.
@item -O @var{format}
@itemx --output-format @var{format}
The output format to generate. @var{format} may be @samp{res},
@samp{rc}, or @samp{coff}. If no output format is specified,
-@code{windres} will guess, as described above.
+@command{windres} will guess, as described above.
@item -F @var{target}
@itemx --target @var{target}
Specify the BFD format to use for a COFF file as input or output. This
-is a BFD target name; you can use the @code{--help} option to see a list
-of supported targets. Normally @code{windres} will use the default
-format, which is the first one listed by the @code{--help} option.
+is a BFD target name; you can use the @option{--help} option to see a list
+of supported targets. Normally @command{windres} will use the default
+format, which is the first one listed by the @option{--help} option.
+@ifclear man
@ref{Target Selection}.
+@end ifclear
@item --preprocessor @var{program}
-When @code{windres} reads an @code{rc} file, it runs it through the C
+When @command{windres} reads an @code{rc} file, it runs it through the C
preprocessor first. This option may be used to specify the preprocessor
to use, including any leading arguments. The default preprocessor
argument is @code{gcc -E -xc-header -DRC_INVOKED}.
-@item --include-dir @var{directory}
+@item -I @var{directory}
+@itemx --include-dir @var{directory}
Specify an include directory to use when reading an @code{rc} file.
-@code{windres} will pass this to the preprocessor as an @code{-I}
-option. @code{windres} will also search this directory when looking for
-files named in the @code{rc} file.
+@command{windres} will pass this to the preprocessor as an @option{-I}
+option. @command{windres} will also search this directory when looking for
+files named in the @code{rc} file. If the argument passed to this command
+matches any of the supported @var{formats} (as descrived in the @option{-J}
+option), it will issue a deprecation warning, and behave just like the
+@option{-J} option. New programs should not use this behaviour. If a
+directory happens to match a @var{format}, simple prefix it with @samp{./}
+to disable the backward compatibility.
@item -D @var{target}
@itemx --define @var{sym}[=@var{val}]
-Specify a @code{-D} option to pass to the preprocessor when reading an
+Specify a @option{-D} option to pass to the preprocessor when reading an
@code{rc} file.
+@item -U @var{target}
+@itemx --undefine @var{sym}
+Specify a @option{-U} option to pass to the preprocessor when reading an
+@code{rc} file.
+
+@item -r
+Ignored for compatibility with rc.
+
@item -v
Enable verbose mode. This tells you what the preprocessor is if you
didn't specify one.
+@item -l @var{val}
@item --language @var{val}
Specify the default language to use when reading an @code{rc} file.
@var{val} should be a hexadecimal language code. The low eight bits are
Use popen, not a temporary file, to read the output of the preprocessor.
This is the default behaviour.
+@item -h
@item --help
Prints a usage summary.
+@item -V
@item --version
-Prints the version number for @code{windres}.
+Prints the version number for @command{windres}.
@item --yydebug
-If @code{windres} is compiled with @code{YYDEBUG} defined as @code{1},
+If @command{windres} is compiled with @code{YYDEBUG} defined as @code{1},
this will turn on parser debugging.
@end table
@end ignore
@node dlltool
-@chapter Create files needed to build and use DLLs
+@chapter dlltool
@cindex DLL
@kindex dlltool
-@code{dlltool} may be used to create the files needed to build and use
-dynamic link libraries (DLLs).
+@command{dlltool} is used to create the files needed to create dynamic
+link libraries (DLLs) on systems which understand PE format image
+files such as Windows. A DLL contains an export table which contains
+information that the runtime loader needs to resolve references from a
+referencing program.
+
+The export table is generated by this program by reading in a
+@file{.def} file or scanning the @file{.a} and @file{.o} files which
+will be in the DLL. A @file{.o} file can contain information in
+special @samp{.drectve} sections with export information.
@quotation
-@emph{Warning:} @code{dlltool} is not always built as part of the binary
-utilities, since it is only useful for those targets which support DLLs.
+@emph{Note:} @command{dlltool} is not always built as part of the
+binary utilities, since it is only useful for those targets which
+support DLLs.
@end quotation
@c man title dlltool Create files needed to build and use DLLs.
@smallexample
@c man begin SYNOPSIS dlltool
-dlltool [-d|--input-def @var{def-file-name}]
- [-b|--base-file @var{base-file-name}]
- [-e|--output-exp @var{exports-file-name}]
- [-z|--output-def @var{def-file-name}]
- [-l|--output-lib @var{library-file-name}]
- [--export-all-symbols] [--no-export-all-symbols]
- [--exclude-symbols @var{list}]
- [--no-default-excludes]
- [-S|--as @var{path-to-assembler}] [-f|--as-flags @var{options}]
- [-D|--dllname @var{name}] [-m|--machine @var{machine}]
- [-a|--add-indirect] [-U|--add-underscore] [-k|--kill-at]
- [-A|--add-stdcall-alias]
- [-x|--no-idata4] [-c|--no-idata5] [-i|--interwork]
- [-n|--nodelete] [-v|--verbose] [-h|--help] [-V|--version]
+dlltool [@option{-d}|@option{--input-def} @var{def-file-name}]
+ [@option{-b}|@option{--base-file} @var{base-file-name}]
+ [@option{-e}|@option{--output-exp} @var{exports-file-name}]
+ [@option{-z}|@option{--output-def} @var{def-file-name}]
+ [@option{-l}|@option{--output-lib} @var{library-file-name}]
+ [@option{--export-all-symbols}] [@option{--no-export-all-symbols}]
+ [@option{--exclude-symbols} @var{list}]
+ [@option{--no-default-excludes}]
+ [@option{-S}|@option{--as} @var{path-to-assembler}] [@option{-f}|@option{--as-flags} @var{options}]
+ [@option{-D}|@option{--dllname} @var{name}] [@option{-m}|@option{--machine} @var{machine}]
+ [@option{-a}|@option{--add-indirect}] [@option{-U}|@option{--add-underscore}] [@option{-k}|@option{--kill-at}]
+ [@option{-A}|@option{--add-stdcall-alias}]
+ [@option{-p}|@option{--ext-prefix-alias} @var{prefix}]
+ [@option{-x}|@option{--no-idata4}] [@option{-c}|@option{--no-idata5}] [@option{-i}|@option{--interwork}]
+ [@option{-n}|@option{--nodelete}] [@option{-t}|@option{--temp-prefix} @var{prefix}]
+ [@option{-v}|@option{--verbose}]
+ [@option{-h}|@option{--help}] [@option{-V}|@option{--version}]
[object-file @dots{}]
@c man end
@end smallexample
@c man begin DESCRIPTION dlltool
-@code{dlltool} reads its inputs, which can come from the @samp{-d} and
-@samp{-b} options as well as object files specified on the command
-line. It then processes these inputs and if the @samp{-e} option has
-been specified it creates a exports file. If the @samp{-l} option
-has been specified it creates a library file and if the @samp{-z} option
-has been specified it creates a def file. Any or all of the -e, -l
-and -z options can be present in one invocation of dlltool.
+@command{dlltool} reads its inputs, which can come from the @option{-d} and
+@option{-b} options as well as object files specified on the command
+line. It then processes these inputs and if the @option{-e} option has
+been specified it creates a exports file. If the @option{-l} option
+has been specified it creates a library file and if the @option{-z} option
+has been specified it creates a def file. Any or all of the @option{-e},
+@option{-l} and @option{-z} options can be present in one invocation of
+dlltool.
When creating a DLL, along with the source for the DLL, it is necessary
-to have three other files. @code{dlltool} can help with the creation of
+to have three other files. @command{dlltool} can help with the creation of
these files.
-The first file is a @samp{.def} file which specifies which functions are
+The first file is a @file{.def} file which specifies which functions are
exported from the DLL, which functions the DLL imports, and so on. This
-is a text file and can be created by hand, or @code{dlltool} can be used
-to create it using the @samp{-z} option. In this case @code{dlltool}
+is a text file and can be created by hand, or @command{dlltool} can be used
+to create it using the @option{-z} option. In this case @command{dlltool}
will scan the object files specified on its command line looking for
those functions which have been specially marked as being exported and
-put entries for them in the .def file it creates.
+put entries for them in the @file{.def} file it creates.
In order to mark a function as being exported from a DLL, it needs to
-have an @samp{-export:<name_of_function>} entry in the @samp{.drectve}
+have an @option{-export:<name_of_function>} entry in the @samp{.drectve}
section of the object file. This can be done in C by using the
asm() operator:
The second file needed for DLL creation is an exports file. This file
is linked with the object files that make up the body of the DLL and it
handles the interface between the DLL and the outside world. This is a
-binary file and it can be created by giving the @samp{-e} option to
-@code{dlltool} when it is creating or reading in a .def file.
+binary file and it can be created by giving the @option{-e} option to
+@command{dlltool} when it is creating or reading in a @file{.def} file.
The third file needed for DLL creation is the library file that programs
will link with in order to access the functions in the DLL. This file
-can be created by giving the @samp{-l} option to dlltool when it
-is creating or reading in a .def file.
+can be created by giving the @option{-l} option to dlltool when it
+is creating or reading in a @file{.def} file.
-@code{dlltool} builds the library file by hand, but it builds the
+@command{dlltool} builds the library file by hand, but it builds the
exports file by creating temporary files containing assembler statements
-and then assembling these. The @samp{-S} command line option can be
+and then assembling these. The @option{-S} command line option can be
used to specify the path to the assembler that dlltool will use,
-and the @samp{-f} option can be used to pass specific flags to that
-assembler. The @samp{-n} can be used to prevent dlltool from deleting
-these temporary assembler files when it is done, and if @samp{-n} is
+and the @option{-f} option can be used to pass specific flags to that
+assembler. The @option{-n} can be used to prevent dlltool from deleting
+these temporary assembler files when it is done, and if @option{-n} is
specified twice then this will prevent dlltool from deleting the
temporary object files it used to build the library.
The command line options have the following meanings:
-@table @code
+@table @env
@item -d @var{filename}
@itemx --input-def @var{filename}
@cindex input .def file
-Specifies the name of a .def file to be read in and processed.
+Specifies the name of a @file{.def} file to be read in and processed.
@item -b @var{filename}
@itemx --base-file @var{filename}
@item -z @var{filename}
@itemx --output-def @var{filename}
-Specifies the name of the .def file to be created by dlltool.
+Specifies the name of the @file{.def} file to be created by dlltool.
@item -l @var{filename}
@itemx --output-lib @var{filename}
@item --export-all-symbols
Treat all global and weak defined symbols found in the input object
files as symbols to be exported. There is a small list of symbols which
-are not exported by default; see the @code{--no-default-excludes}
+are not exported by default; see the @option{--no-default-excludes}
option. You may add to the list of symbols to not export by using the
-@code{--exclude-symbols} option.
+@option{--exclude-symbols} option.
@item --no-export-all-symbols
-Only export symbols explicitly listed in an input .def file or in
+Only export symbols explicitly listed in an input @file{.def} file or in
@samp{.drectve} sections in the input object files. This is the default
behaviour. The @samp{.drectve} sections are created by @samp{dllexport}
attributes in the source code.
Do not export the symbols in @var{list}. This is a list of symbol names
separated by comma or colon characters. The symbol names should not
contain a leading underscore. This is only meaningful when
-@code{--export-all-symbols} is used.
+@option{--export-all-symbols} is used.
@item --no-default-excludes
-When @code{--export-all-symbols} is used, it will by default avoid
+When @option{--export-all-symbols} is used, it will by default avoid
exporting certain special symbols. The current list of symbols to avoid
exporting is @samp{DllMain@@12}, @samp{DllEntryPoint@@0},
-@samp{impure_ptr}. You may use the @code{--no-default-excludes} option
+@samp{impure_ptr}. You may use the @option{--no-default-excludes} option
to go ahead and export these special symbols. This is only meaningful
-when @code{--export-all-symbols} is used.
+when @option{--export-all-symbols} is used.
@item -S @var{path}
@itemx --as @var{path}
Specifies the path, including the filename, of the assembler to be used
to create the exports file.
-@item -f @var{switches}
-@itemx --as-flags @var{switches}
-Specifies any specific command line switches to be passed to the
+@item -f @var{options}
+@itemx --as-flags @var{options}
+Specifies any specific command line options to be passed to the
assembler when building the exports file. This option will work even if
-the @samp{-S} option is not used. This option only takes one argument,
+the @option{-S} option is not used. This option only takes one argument,
and if it occurs more than once on the command line, then later
occurrences will override earlier occurrences. So if it is necessary to
-pass multiple switches to the assembler they should be enclosed in
+pass multiple options to the assembler they should be enclosed in
double quotes.
@item -D @var{name}
@itemx --dll-name @var{name}
-Specifies the name to be stored in the .def file as the name of the DLL
-when the @samp{-e} option is used. If this option is not present, then
-the filename given to the @samp{-e} option will be used as the name of
-the DLL.
+Specifies the name to be stored in the @file{.def} file as the name of
+the DLL when the @option{-e} option is used. If this option is not
+present, then the filename given to the @option{-e} option will be
+used as the name of the DLL.
@item -m @var{machine}
@itemx -machine @var{machine}
Specifies the type of machine for which the library file should be
-built. @code{dlltool} has a built in default type, depending upon how
+built. @command{dlltool} has a built in default type, depending upon how
it was created, but this option can be used to override that. This is
normally only useful when creating DLLs for an ARM processor, when the
-contents of the DLL are actually encode using THUMB instructions.
+contents of the DLL are actually encode using Thumb instructions.
@item -a
@itemx --add-indirect
-Specifies that when @code{dlltool} is creating the exports file it
+Specifies that when @command{dlltool} is creating the exports file it
should add a section which allows the exported functions to be
referenced without using the import library. Whatever the hell that
means!
@item -U
@itemx --add-underscore
-Specifies that when @code{dlltool} is creating the exports file it
+Specifies that when @command{dlltool} is creating the exports file it
should prepend an underscore to the names of the exported functions.
@item -k
@itemx --kill-at
-Specifies that when @code{dlltool} is creating the exports file it
+Specifies that when @command{dlltool} is creating the exports file it
should not append the string @samp{@@ <number>}. These numbers are
called ordinal numbers and they represent another way of accessing the
function in a DLL, other than by name.
@item -A
@itemx --add-stdcall-alias
-Specifies that when @code{dlltool} is creating the exports file it
+Specifies that when @command{dlltool} is creating the exports file it
should add aliases for stdcall symbols without @samp{@@ <number>}
in addition to the symbols with @samp{@@ <number>}.
+@item -p
+@itemx --ext-prefix-alias @var{prefix}
+Causes @command{dlltool} to create external aliases for all DLL
+imports with the specified prefix. The aliases are created for both
+external and import symbols with no leading underscore.
+
@item -x
@itemx --no-idata4
-Specifies that when @code{dlltool} is creating the exports and library
-files it should omit the .idata4 section. This is for compatibility
+Specifies that when @command{dlltool} is creating the exports and library
+files it should omit the @code{.idata4} section. This is for compatibility
with certain operating systems.
@item -c
@itemx --no-idata5
-Specifies that when @code{dlltool} is creating the exports and library
-files it should omit the .idata5 section. This is for compatibility
+Specifies that when @command{dlltool} is creating the exports and library
+files it should omit the @code{.idata5} section. This is for compatibility
with certain operating systems.
@item -i
@itemx --interwork
-Specifies that @code{dlltool} should mark the objects in the library
+Specifies that @command{dlltool} should mark the objects in the library
file and exports file that it produces as supporting interworking
-between ARM and THUMB code.
+between ARM and Thumb code.
@item -n
@itemx --nodelete
-Makes @code{dlltool} preserve the temporary assembler files it used to
+Makes @command{dlltool} preserve the temporary assembler files it used to
create the exports file. If this option is repeated then dlltool will
also preserve the temporary object files it uses to create the library
-file.
+file.
+
+@item -t @var{prefix}
+@itemx --temp-prefix @var{prefix}
+Makes @command{dlltool} use @var{prefix} when constructing the names of
+temporary assembler and object files. By default, the temp file prefix
+is generated from the pid.
@item -v
@itemx --verbose
@c man end
+@menu
+* def file format:: The format of the dlltool @file{.def} file
+@end menu
+
+@node def file format
+@section The format of the @command{dlltool} @file{.def} file
+
+A @file{.def} file contains any number of the following commands:
+
+@table @asis
+
+@item @code{NAME} @var{name} @code{[ ,} @var{base} @code{]}
+The result is going to be named @var{name}@code{.exe}.
+
+@item @code{LIBRARY} @var{name} @code{[ ,} @var{base} @code{]}
+The result is going to be named @var{name}@code{.dll}.
+
+@item @code{EXPORTS ( ( (} @var{name1} @code{[ = } @var{name2} @code{] ) | ( } @var{name1} @code{=} @var{module-name} @code{.} @var{external-name} @code{) )}
+@item @code{[} @var{integer} @code{] [ NONAME ] [ CONSTANT ] [ DATA ] [ PRIVATE ] ) *}
+Declares @var{name1} as an exported symbol from the DLL, with optional
+ordinal number @var{integer}, or declares @var{name1} as an alias
+(forward) of the function @var{external-name} in the DLL
+@var{module-name}.
+
+@item @code{IMPORTS ( (} @var{internal-name} @code{=} @var{module-name} @code{.} @var{integer} @code{) | [} @var{internal-name} @code{= ]} @var{module-name} @code{.} @var{external-name} @code{) ) *}
+Declares that @var{external-name} or the exported function whose
+ordinal number is @var{integer} is to be imported from the file
+@var{module-name}. If @var{internal-name} is specified then this is
+the name that the imported function will be referred to in the body of
+the DLL.
+
+@item @code{DESCRIPTION} @var{string}
+Puts @var{string} into the output @file{.exp} file in the
+@code{.rdata} section.
+
+@item @code{STACKSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
+@item @code{HEAPSIZE} @var{number-reserve} @code{[, } @var{number-commit} @code{]}
+Generates @code{--stack} or @code{--heap}
+@var{number-reserve},@var{number-commit} in the output @code{.drectve}
+section. The linker will see this and act upon it.
+
+@item @code{CODE} @var{attr} @code{+}
+@item @code{DATA} @var{attr} @code{+}
+@item @code{SECTIONS (} @var{section-name} @var{attr}@code{ + ) *}
+Generates @code{--attr} @var{section-name} @var{attr} in the output
+@code{.drectve} section, where @var{attr} is one of @code{READ},
+@code{WRITE}, @code{EXECUTE} or @code{SHARED}. The linker will see
+this and act upon it.
+
+@end table
+
@ignore
@c man begin SEEALSO dlltool
-the Info entries for @file{binutils}.
+The Info pages for @file{binutils}.
@c man end
@end ignore
@smallexample
@c man begin SYNOPSIS readelf
-readelf [ -a | --all ]
- [ -h | --file-header]
- [ -l | --program-headers | --segments]
- [ -S | --section-headers | --sections]
- [ -e | --headers]
- [ -s | --syms | --symbols]
- [ -n | --notes]
- [ -r | --relocs]
- [ -u | --unwind]
- [ -d | --dynamic]
- [ -V | --version-info]
- [ -D | --use-dynamic]
- [ -x <number> | --hex-dump=<number>]
- [ -w[liaprf] | --debug-dump[=info,=line,=abbrev,=pubnames,=ranges,=frames]]
- [ --histogram]
- [ -v | --version]
- [ -H | --help]
+readelf [@option{-a}|@option{--all}]
+ [@option{-h}|@option{--file-header}]
+ [@option{-l}|@option{--program-headers}|@option{--segments}]
+ [@option{-S}|@option{--section-headers}|@option{--sections}]
+ [@option{-g}|@option{--section-groups}]
+ [@option{-t}|@option{--section-details}]
+ [@option{-e}|@option{--headers}]
+ [@option{-s}|@option{--syms}|@option{--symbols}]
+ [@option{-n}|@option{--notes}]
+ [@option{-r}|@option{--relocs}]
+ [@option{-u}|@option{--unwind}]
+ [@option{-d}|@option{--dynamic}]
+ [@option{-V}|@option{--version-info}]
+ [@option{-A}|@option{--arch-specific}]
+ [@option{-D}|@option{--use-dynamic}]
+ [@option{-x} <number or name>|@option{--hex-dump=}<number or name>]
+ [@option{-w[liaprmfFsoR]}|
+ @option{--debug-dump}[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]]
+ [@option{-I}|@option{-histogram}]
+ [@option{-v}|@option{--version}]
+ [@option{-W}|@option{--wide}]
+ [@option{-H}|@option{--help}]
@var{elffile}@dots{}
@c man end
@end smallexample
@c man begin DESCRIPTION readelf
-@code{readelf} displays information about one or more ELF format object
+@command{readelf} displays information about one or more ELF format object
files. The options control what particular information to display.
-@var{elffile}@dots{} are the object files to be examined. At the
-moment, @code{readelf} does not support examining archives, nor does it
-support examing 64 bit ELF files.
+@var{elffile}@dots{} are the object files to be examined. 32-bit and
+64-bit ELF files are supported, as are archives containing ELF files.
+
+This program performs a similar function to @command{objdump} but it
+goes into more detail and it exists independently of the @sc{bfd}
+library, so if there is a bug in @sc{bfd} then readelf will not be
+affected.
@c man end
equivalent. At least one option besides @samp{-v} or @samp{-H} must be
given.
-@table @code
+@table @env
@item -a
@itemx --all
-Equivalent to specifiying @samp{--file-header},
-@samp{--program-headers}, @samp{--sections}, @samp{--symbols},
-@samp{--relocs}, @samp{--dynamic}, @samp{--notes} and
-@samp{--version-info}.
+Equivalent to specifiying @option{--file-header},
+@option{--program-headers}, @option{--sections}, @option{--symbols},
+@option{--relocs}, @option{--dynamic}, @option{--notes} and
+@option{--version-info}.
@item -h
@itemx --file-header
Displays the information contained in the file's section headers, if it
has any.
+@item -g
+@itemx --section-groups
+@cindex ELF section group information
+Displays the information contained in the file's section groups, if it
+has any.
+
+@item -t
+@itemx --section-details
+@cindex ELF section information
+Displays the detailed section information. Implies @option{-S}.
+
@item -s
@itemx --symbols
@itemx --syms
@item -e
@itemx --headers
-Display all the headers in the file. Equivalent to @samp{-h -l -S}.
+Display all the headers in the file. Equivalent to @option{-h -l -S}.
@item -n
@itemx --notes
-@cindex ELF core notes
-Displays the contents of the NOTE segment, if it exists.
+@cindex ELF notes
+Displays the contents of the NOTE segments and/or sections, if any.
@item -r
@itemx --relocs
Displays the contents of the version sections in the file, it they
exist.
+@item -A
+@itemx --arch-specific
+Displays architecture-specific information in the file, if there
+is any.
+
@item -D
@itemx --use-dynamic
-When displaying symbols, this option makes @code{readelf} use the
+When displaying symbols, this option makes @command{readelf} use the
symbol table in the file's dynamic section, rather than the one in the
symbols section.
-@item -x <number>
-@itemx --hex-dump=<number>
+@item -x <number or name>
+@itemx --hex-dump=<number or name>
Displays the contents of the indicated section as a hexadecimal dump.
+A number identifies a particular section by index in the section table;
+any other string identifies all sections with that name in the object file.
-@item -w[liaprf]
-@itemx --debug-dump[=line,=info,=abbrev,=pubnames,=ranges,=frames]
+@item -w[liaprmfFsoR]
+@itemx --debug-dump[=line,=info,=abbrev,=pubnames,=aranges,=macro,=frames,=frames-interp,=str,=loc,=Ranges]
Displays the contents of the debug sections in the file, if any are
present. If one of the optional letters or words follows the switch
then only data found in those specific sections will be dumped.
-@item --histogram
+@item -I
+@itemx --histogram
Display a histogram of bucket list lengths when displaying the contents
of the symbol tables.
@itemx --version
Display the version number of readelf.
+@item -W
+@itemx --wide
+Don't break output lines to fit into 80 columns. By default
+@command{readelf} breaks section header and segment listing lines for
+64-bit ELF files, so that they fit into 80 columns. This option causes
+@command{readelf} to print each section header resp. each segment one a
+single line, which is far more readable on terminals wider than 80 columns.
+
@item -H
@itemx --help
-Display the command line options understood by @code{readelf}.
+Display the command line options understood by @command{readelf}.
@end table
@c man end
@end ignore
+@node Common Options
+@chapter Common Options
+
+The following command-line options are supported by all of the
+programs described in this manual.
+
+@c man begin OPTIONS
+@table @env
+@include @value{top_srcdir}/../libiberty/at-file.texi
+@c man end
+
+@item --help
+Display the command-line options supported by the program.
+
+@item --version
+Display the version number of the program.
+
+@c man begin OPTIONS
+@end table
+@c man end
+
@node Selecting The Target System
-@chapter Selecting the target system
+@chapter Selecting the Target System
-You can specify three aspects of the target system to the @sc{gnu}
+You can specify two aspects of the target system to the @sc{gnu}
binary file utilities, each in several ways:
@itemize @bullet
@item
the architecture
-
-@item
-the linker emulation (which applies to the linker only)
@end itemize
In the following summaries, the lists of ways to specify values are in
The commands to list valid values only list the values for which the
programs you are running were configured. If they were configured with
-@samp{--enable-targets=all}, the commands list most of the available
+@option{--enable-targets=all}, the commands list most of the available
values, but a few are left out; not all targets can be configured in at
once because some of them can only be configured @dfn{native} (on hosts
with the same type as the target system).
@menu
* Target Selection::
* Architecture Selection::
-* Linker Emulation Selection::
@end menu
@node Target Selection
Some sample configuration triplets are: @samp{m68k-hp-bsd},
@samp{mips-dec-ultrix}, @samp{sparc-sun-sunos}.
-@subheading @code{objdump} Target
+@subheading @command{objdump} Target
Ways to specify:
@enumerate
@item
-command line option: @samp{-b} or @samp{--target}
+command line option: @option{-b} or @option{--target}
@item
environment variable @code{GNUTARGET}
deduced from the input file
@end enumerate
-@subheading @code{objcopy} and @code{strip} Input Target
+@subheading @command{objcopy} and @command{strip} Input Target
Ways to specify:
@enumerate
@item
-command line options: @samp{-I} or @samp{--input-target}, or @samp{-F} or @samp{--target}
+command line options: @option{-I} or @option{--input-target}, or @option{-F} or @option{--target}
@item
environment variable @code{GNUTARGET}
deduced from the input file
@end enumerate
-@subheading @code{objcopy} and @code{strip} Output Target
+@subheading @command{objcopy} and @command{strip} Output Target
Ways to specify:
@enumerate
@item
-command line options: @samp{-O} or @samp{--output-target}, or @samp{-F} or @samp{--target}
+command line options: @option{-O} or @option{--output-target}, or @option{-F} or @option{--target}
@item
-the input target (see ``@code{objcopy} and @code{strip} Input Target'' above)
+the input target (see ``@command{objcopy} and @command{strip} Input Target'' above)
@item
environment variable @code{GNUTARGET}
deduced from the input file
@end enumerate
-@subheading @code{nm}, @code{size}, and @code{strings} Target
+@subheading @command{nm}, @command{size}, and @command{strings} Target
Ways to specify:
@enumerate
@item
-command line option: @samp{--target}
+command line option: @option{--target}
@item
environment variable @code{GNUTARGET}
deduced from the input file
@end enumerate
-@subheading Linker Input Target
-
-Ways to specify:
-
-@enumerate
-@item
-command line option: @samp{-b} or @samp{--format}
-(@pxref{Options,,Options,ld.info,Using LD})
-
-@item
-script command @code{TARGET}
-(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
-
-@item
-environment variable @code{GNUTARGET}
-(@pxref{Environment,,Environment,ld.info,Using LD})
-
-@item
-the default target of the selected linker emulation
-(@pxref{Linker Emulation Selection})
-@end enumerate
-
-@subheading Linker Output Target
-
-Ways to specify:
-
-@enumerate
-@item
-command line option: @samp{-oformat}
-(@pxref{Options,,Options,ld.info,Using LD})
-
-@item
-script command @code{OUTPUT_FORMAT}
-(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
-
-@item
-the linker input target (see ``Linker Input Target'' above)
-@end enumerate
-
@node Architecture Selection
-@section Architecture selection
+@section Architecture Selection
An @dfn{architecture} is a type of @sc{cpu} on which an object file is
to run. Its name may contain a colon, separating the name of the
Sample values: @samp{m68k:68020}, @samp{mips:3000}, @samp{sparc}.
-@subheading @code{objdump} Architecture
+@subheading @command{objdump} Architecture
Ways to specify:
@enumerate
@item
-command line option: @samp{-m} or @samp{--architecture}
+command line option: @option{-m} or @option{--architecture}
@item
deduced from the input file
@end enumerate
-@subheading @code{objcopy}, @code{nm}, @code{size}, @code{strings} Architecture
+@subheading @command{objcopy}, @command{nm}, @command{size}, @command{strings} Architecture
Ways to specify:
deduced from the input file
@end enumerate
-@subheading Linker Input Architecture
-
-Ways to specify:
-
-@enumerate
-@item
-deduced from the input file
-@end enumerate
-
-@subheading Linker Output Architecture
-
-Ways to specify:
-
-@enumerate
-@item
-script command @code{OUTPUT_ARCH}
-(@pxref{Option Commands,,Option Commands,ld.info,Using LD})
-
-@item
-the default architecture from the linker output target
-(@pxref{Target Selection})
-@end enumerate
-
-@node Linker Emulation Selection
-@section Linker emulation selection
-
-A linker @dfn{emulation} is a ``personality'' of the linker, which gives
-the linker default values for the other aspects of the target system.
-In particular, it consists of
-
-@itemize @bullet
-@item
-the linker script
-
-@item
-the target
-
-@item
-several ``hook'' functions that are run at certain stages of the linking
-process to do special things that some targets require
-@end itemize
-
-The command to list valid linker emulation values is @samp{ld -V}.
-
-Sample values: @samp{hp300bsd}, @samp{mipslit}, @samp{sun4}.
-
-Ways to specify:
-
-@enumerate
-@item
-command line option: @samp{-m}
-(@pxref{Options,,Options,ld.info,Using LD})
-
-@item
-environment variable @code{LDEMULATION}
-
-@item
-compiled-in @code{DEFAULT_EMULATION} from @file{Makefile},
-which comes from @code{EMUL} in @file{config/@var{target}.mt}
-@end enumerate
-
@node Reporting Bugs
@chapter Reporting Bugs
@cindex bugs
@end menu
@node Bug Criteria
-@section Have you found a bug?
+@section Have You Found a Bug?
@cindex bug criteria
If you are not sure whether you have found a bug, here are some guidelines:
@end itemize
@node Bug Reporting
-@section How to report bugs
+@section How to Report Bugs
@cindex bug reports
@cindex bugs, reporting
that the bug has not been reported previously.
Sometimes people give a few sketchy facts and ask, ``Does this ring a
-bell?'' Those bug reports are useless, and we urge everyone to
-@emph{refuse to respond to them} except to chide the sender to report
-bugs properly.
+bell?'' This cannot help us fix a bug, so it is basically useless. We
+respond by asking for enough details to enable us to investigate.
+You might as well expedite matters by sending them to begin with.
To enable us to fix the bug, you should include all these things:
@itemize @bullet
@item
The version of the utility. Each utility announces it if you start it
-with the @samp{--version} argument.
+with the @option{--version} argument.
Without this, we will not know whether there is any point in looking for
the bug in the current version of the binary utilities.
anonymous FTP is OK.
If the source files were produced exclusively using @sc{gnu} programs
-(e.g., @code{gcc}, @code{gas}, and/or the @sc{gnu} @code{ld}), then it
+(e.g., @command{gcc}, @command{gas}, and/or the @sc{gnu} @command{ld}), then it
may be OK to send the source files rather than the object files. In
-this case, be sure to say exactly what version of @code{gcc}, or
+this case, be sure to say exactly what version of @command{gcc}, or
whatever, was used to produce the object files. Also say how
-@code{gcc}, or whatever, was configured.
+@command{gcc}, or whatever, was configured.
@item
A description of what behavior you observe that you believe is
@item
If you wish to suggest changes to the source, send us context diffs, as
-generated by @code{diff} with the @samp{-u}, @samp{-c}, or @samp{-p}
+generated by @command{diff} with the @option{-u}, @option{-c}, or @option{-p}
option. Always send diffs from the old file to the new file. If you
-wish to discuss something in the @code{ld} source, refer to it by
+wish to discuss something in the @command{ld} source, refer to it by
context, not by line number.
The line numbers in our development sources will not match those in your
things without first using the debugger to find the facts.
@end itemize
-@node GNU Free Documentation License
-@chapter GNU Free Documentation License
-@cindex GNU Free Documentation License
-
- GNU Free Documentation License
-
- Version 1.1, March 2000
-
- Copyright (C) 2000 Free Software Foundation, Inc.
- 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
-
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-0. PREAMBLE
-
-The purpose of this License is to make a manual, textbook, or other
-written document "free" in the sense of freedom: to assure everyone
-the effective freedom to copy and redistribute it, with or without
-modifying it, either commercially or noncommercially. Secondarily,
-this License preserves for the author and publisher a way to get
-credit for their work, while not being considered responsible for
-modifications made by others.
-
-This License is a kind of "copyleft", which means that derivative
-works of the document must themselves be free in the same sense. It
-complements the GNU General Public License, which is a copyleft
-license designed for free software.
-
-We have designed this License in order to use it for manuals for free
-software, because free software needs free documentation: a free
-program should come with manuals providing the same freedoms that the
-software does. But this License is not limited to software manuals;
-it can be used for any textual work, regardless of subject matter or
-whether it is published as a printed book. We recommend this License
-principally for works whose purpose is instruction or reference.
-
-
-1. APPLICABILITY AND DEFINITIONS
-
-This License applies to any manual or other work that contains a
-notice placed by the copyright holder saying it can be distributed
-under the terms of this License. The "Document", below, refers to any
-such manual or work. Any member of the public is a licensee, and is
-addressed as "you".
-
-A "Modified Version" of the Document means any work containing the
-Document or a portion of it, either copied verbatim, or with
-modifications and/or translated into another language.
-
-A "Secondary Section" is a named appendix or a front-matter section of
-the Document that deals exclusively with the relationship of the
-publishers or authors of the Document to the Document's overall subject
-(or to related matters) and contains nothing that could fall directly
-within that overall subject. (For example, if the Document is in part a
-textbook of mathematics, a Secondary Section may not explain any
-mathematics.) The relationship could be a matter of historical
-connection with the subject or with related matters, or of legal,
-commercial, philosophical, ethical or political position regarding
-them.
-
-The "Invariant Sections" are certain Secondary Sections whose titles
-are designated, as being those of Invariant Sections, in the notice
-that says that the Document is released under this License.
-
-The "Cover Texts" are certain short passages of text that are listed,
-as Front-Cover Texts or Back-Cover Texts, in the notice that says that
-the Document is released under this License.
-
-A "Transparent" copy of the Document means a machine-readable copy,
-represented in a format whose specification is available to the
-general public, whose contents can be viewed and edited directly and
-straightforwardly with generic text editors or (for images composed of
-pixels) generic paint programs or (for drawings) some widely available
-drawing editor, and that is suitable for input to text formatters or
-for automatic translation to a variety of formats suitable for input
-to text formatters. A copy made in an otherwise Transparent file
-format whose markup has been designed to thwart or discourage
-subsequent modification by readers is not Transparent. A copy that is
-not "Transparent" is called "Opaque".
-
-Examples of suitable formats for Transparent copies include plain
-ASCII without markup, Texinfo input format, LaTeX input format, SGML
-or XML using a publicly available DTD, and standard-conforming simple
-HTML designed for human modification. Opaque formats include
-PostScript, PDF, proprietary formats that can be read and edited only
-by proprietary word processors, SGML or XML for which the DTD and/or
-processing tools are not generally available, and the
-machine-generated HTML produced by some word processors for output
-purposes only.
-
-The "Title Page" means, for a printed book, the title page itself,
-plus such following pages as are needed to hold, legibly, the material
-this License requires to appear in the title page. For works in
-formats which do not have any title page as such, "Title Page" means
-the text near the most prominent appearance of the work's title,
-preceding the beginning of the body of the text.
-
-
-2. VERBATIM COPYING
-
-You may copy and distribute the Document in any medium, either
-commercially or noncommercially, provided that this License, the
-copyright notices, and the license notice saying this License applies
-to the Document are reproduced in all copies, and that you add no other
-conditions whatsoever to those of this License. You may not use
-technical measures to obstruct or control the reading or further
-copying of the copies you make or distribute. However, you may accept
-compensation in exchange for copies. If you distribute a large enough
-number of copies you must also follow the conditions in section 3.
-
-You may also lend copies, under the same conditions stated above, and
-you may publicly display copies.
-
-
-3. COPYING IN QUANTITY
-
-If you publish printed copies of the Document numbering more than 100,
-and the Document's license notice requires Cover Texts, you must enclose
-the copies in covers that carry, clearly and legibly, all these Cover
-Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
-the back cover. Both covers must also clearly and legibly identify
-you as the publisher of these copies. The front cover must present
-the full title with all words of the title equally prominent and
-visible. You may add other material on the covers in addition.
-Copying with changes limited to the covers, as long as they preserve
-the title of the Document and satisfy these conditions, can be treated
-as verbatim copying in other respects.
-
-If the required texts for either cover are too voluminous to fit
-legibly, you should put the first ones listed (as many as fit
-reasonably) on the actual cover, and continue the rest onto adjacent
-pages.
-
-If you publish or distribute Opaque copies of the Document numbering
-more than 100, you must either include a machine-readable Transparent
-copy along with each Opaque copy, or state in or with each Opaque copy
-a publicly-accessible computer-network location containing a complete
-Transparent copy of the Document, free of added material, which the
-general network-using public has access to download anonymously at no
-charge using public-standard network protocols. If you use the latter
-option, you must take reasonably prudent steps, when you begin
-distribution of Opaque copies in quantity, to ensure that this
-Transparent copy will remain thus accessible at the stated location
-until at least one year after the last time you distribute an Opaque
-copy (directly or through your agents or retailers) of that edition to
-the public.
-
-It is requested, but not required, that you contact the authors of the
-Document well before redistributing any large number of copies, to give
-them a chance to provide you with an updated version of the Document.
-
-
-4. MODIFICATIONS
-
-You may copy and distribute a Modified Version of the Document under
-the conditions of sections 2 and 3 above, provided that you release
-the Modified Version under precisely this License, with the Modified
-Version filling the role of the Document, thus licensing distribution
-and modification of the Modified Version to whoever possesses a copy
-of it. In addition, you must do these things in the Modified Version:
-
-A. Use in the Title Page (and on the covers, if any) a title distinct
- from that of the Document, and from those of previous versions
- (which should, if there were any, be listed in the History section
- of the Document). You may use the same title as a previous version
- if the original publisher of that version gives permission.
-B. List on the Title Page, as authors, one or more persons or entities
- responsible for authorship of the modifications in the Modified
- Version, together with at least five of the principal authors of the
- Document (all of its principal authors, if it has less than five).
-C. State on the Title page the name of the publisher of the
- Modified Version, as the publisher.
-D. Preserve all the copyright notices of the Document.
-E. Add an appropriate copyright notice for your modifications
- adjacent to the other copyright notices.
-F. Include, immediately after the copyright notices, a license notice
- giving the public permission to use the Modified Version under the
- terms of this License, in the form shown in the Addendum below.
-G. Preserve in that license notice the full lists of Invariant Sections
- and required Cover Texts given in the Document's license notice.
-H. Include an unaltered copy of this License.
-I. Preserve the section entitled "History", and its title, and add to
- it an item stating at least the title, year, new authors, and
- publisher of the Modified Version as given on the Title Page. If
- there is no section entitled "History" in the Document, create one
- stating the title, year, authors, and publisher of the Document as
- given on its Title Page, then add an item describing the Modified
- Version as stated in the previous sentence.
-J. Preserve the network location, if any, given in the Document for
- public access to a Transparent copy of the Document, and likewise
- the network locations given in the Document for previous versions
- it was based on. These may be placed in the "History" section.
- You may omit a network location for a work that was published at
- least four years before the Document itself, or if the original
- publisher of the version it refers to gives permission.
-K. In any section entitled "Acknowledgements" or "Dedications",
- preserve the section's title, and preserve in the section all the
- substance and tone of each of the contributor acknowledgements
- and/or dedications given therein.
-L. Preserve all the Invariant Sections of the Document,
- unaltered in their text and in their titles. Section numbers
- or the equivalent are not considered part of the section titles.
-M. Delete any section entitled "Endorsements". Such a section
- may not be included in the Modified Version.
-N. Do not retitle any existing section as "Endorsements"
- or to conflict in title with any Invariant Section.
-
-If the Modified Version includes new front-matter sections or
-appendices that qualify as Secondary Sections and contain no material
-copied from the Document, you may at your option designate some or all
-of these sections as invariant. To do this, add their titles to the
-list of Invariant Sections in the Modified Version's license notice.
-These titles must be distinct from any other section titles.
-
-You may add a section entitled "Endorsements", provided it contains
-nothing but endorsements of your Modified Version by various
-parties--for example, statements of peer review or that the text has
-been approved by an organization as the authoritative definition of a
-standard.
-
-You may add a passage of up to five words as a Front-Cover Text, and a
-passage of up to 25 words as a Back-Cover Text, to the end of the list
-of Cover Texts in the Modified Version. Only one passage of
-Front-Cover Text and one of Back-Cover Text may be added by (or
-through arrangements made by) any one entity. If the Document already
-includes a cover text for the same cover, previously added by you or
-by arrangement made by the same entity you are acting on behalf of,
-you may not add another; but you may replace the old one, on explicit
-permission from the previous publisher that added the old one.
-
-The author(s) and publisher(s) of the Document do not by this License
-give permission to use their names for publicity for or to assert or
-imply endorsement of any Modified Version.
-
-
-5. COMBINING DOCUMENTS
-
-You may combine the Document with other documents released under this
-License, under the terms defined in section 4 above for modified
-versions, provided that you include in the combination all of the
-Invariant Sections of all of the original documents, unmodified, and
-list them all as Invariant Sections of your combined work in its
-license notice.
-
-The combined work need only contain one copy of this License, and
-multiple identical Invariant Sections may be replaced with a single
-copy. If there are multiple Invariant Sections with the same name but
-different contents, make the title of each such section unique by
-adding at the end of it, in parentheses, the name of the original
-author or publisher of that section if known, or else a unique number.
-Make the same adjustment to the section titles in the list of
-Invariant Sections in the license notice of the combined work.
-
-In the combination, you must combine any sections entitled "History"
-in the various original documents, forming one section entitled
-"History"; likewise combine any sections entitled "Acknowledgements",
-and any sections entitled "Dedications". You must delete all sections
-entitled "Endorsements."
-
-
-6. COLLECTIONS OF DOCUMENTS
-
-You may make a collection consisting of the Document and other documents
-released under this License, and replace the individual copies of this
-License in the various documents with a single copy that is included in
-the collection, provided that you follow the rules of this License for
-verbatim copying of each of the documents in all other respects.
-
-You may extract a single document from such a collection, and distribute
-it individually under this License, provided you insert a copy of this
-License into the extracted document, and follow this License in all
-other respects regarding verbatim copying of that document.
-
-
-7. AGGREGATION WITH INDEPENDENT WORKS
-
-A compilation of the Document or its derivatives with other separate
-and independent documents or works, in or on a volume of a storage or
-distribution medium, does not as a whole count as a Modified Version
-of the Document, provided no compilation copyright is claimed for the
-compilation. Such a compilation is called an "aggregate", and this
-License does not apply to the other self-contained works thus compiled
-with the Document, on account of their being thus compiled, if they
-are not themselves derivative works of the Document.
-
-If the Cover Text requirement of section 3 is applicable to these
-copies of the Document, then if the Document is less than one quarter
-of the entire aggregate, the Document's Cover Texts may be placed on
-covers that surround only the Document within the aggregate.
-Otherwise they must appear on covers around the whole aggregate.
-
-
-8. TRANSLATION
-
-Translation is considered a kind of modification, so you may
-distribute translations of the Document under the terms of section 4.
-Replacing Invariant Sections with translations requires special
-permission from their copyright holders, but you may include
-translations of some or all Invariant Sections in addition to the
-original versions of these Invariant Sections. You may include a
-translation of this License provided that you also include the
-original English version of this License. In case of a disagreement
-between the translation and the original English version of this
-License, the original English version will prevail.
-
-
-9. TERMINATION
-
-You may not copy, modify, sublicense, or distribute the Document except
-as expressly provided for under this License. Any other attempt to
-copy, modify, sublicense or distribute the Document is void, and will
-automatically terminate your rights under this License. However,
-parties who have received copies, or rights, from you under this
-License will not have their licenses terminated so long as such
-parties remain in full compliance.
-
-
-10. FUTURE REVISIONS OF THIS LICENSE
-
-The Free Software Foundation may publish new, revised versions
-of the GNU Free Documentation License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns. See
-http://www.gnu.org/copyleft/.
-
-Each version of the License is given a distinguishing version number.
-If the Document specifies that a particular numbered version of this
-License "or any later version" applies to it, you have the option of
-following the terms and conditions either of that specified version or
-of any later version that has been published (not as a draft) by the
-Free Software Foundation. If the Document does not specify a version
-number of this License, you may choose any version ever published (not
-as a draft) by the Free Software Foundation.
-
-
-ADDENDUM: How to use this License for your documents
-
-To use this License in a document you have written, include a copy of
-the License in the document and put the following copyright and
-license notices just after the title page:
-
-@smallexample
- Copyright (c) YEAR YOUR NAME.
- Permission is granted to copy, distribute and/or modify this document
- under the terms of the GNU Free Documentation License, Version 1.1
- or any later version published by the Free Software Foundation;
- with the Invariant Sections being LIST THEIR TITLES, with the
- Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
- A copy of the license is included in the section entitled "GNU
- Free Documentation License".
-@end smallexample
-
-If you have no Invariant Sections, write "with no Invariant Sections"
-instead of saying which ones are invariant. If you have no
-Front-Cover Texts, write "no Front-Cover Texts" instead of
-"Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
-
-If your document contains nontrivial examples of program code, we
-recommend releasing these examples in parallel under your choice of
-free software license, such as the GNU General Public License,
-to permit their use in free software.
+@include fdl.texi
@node Index
@unnumbered Index
projects / deliverable / binutils-gdb.git / blobdiff