Subversion Repositories openrisc_me

\input texinfo       @c                    -*- Texinfo -*-

\input texinfo       @c                    -*- Texinfo -*-

@setfilename binutils.info

@setfilename binutils.info

@settitle @sc{gnu} Binary Utilities

@settitle @sc{gnu} Binary Utilities

@finalout

@finalout

@synindex ky cp

@synindex ky cp

@c man begin INCLUDE

@c man begin INCLUDE

@include bfdver.texi

@include bfdver.texi

@c man end

@c man end

@copying

@copying

@c man begin COPYRIGHT

@c man begin COPYRIGHT

Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,

Copyright @copyright{} 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,

2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.

2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.

Permission is granted to copy, distribute and/or modify this document

Permission is granted to copy, distribute and/or modify this document

under the terms of the GNU Free Documentation License, Version 1.2

under the terms of the GNU Free Documentation License, Version 1.2

or any later version published by the Free Software Foundation;

or any later version published by the Free Software Foundation;

with no Invariant Sections, with no Front-Cover Texts, and with no

with no Invariant Sections, with no Front-Cover Texts, and with no

Back-Cover Texts.  A copy of the license is included in the

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

@c man end

@end copying

@end copying

@dircategory Software development

@dircategory Software development

@direntry

@direntry

* Binutils: (binutils).         The GNU binary utilities.

* Binutils: (binutils).         The GNU binary utilities.

@end direntry

@end direntry

@dircategory Individual utilities

@dircategory Individual utilities

@direntry

@direntry

* addr2line: (binutils)addr2line. Convert addresses to file and line.

* addr2line: (binutils)addr2line. Convert addresses to file and line.

* ar: (binutils)ar.               Create, modify, and extract from archives.

* ar: (binutils)ar.               Create, modify, and extract from archives.

* c++filt: (binutils)c++filt.     Filter to demangle encoded C++ symbols.

* c++filt: (binutils)c++filt.     Filter to demangle encoded C++ symbols.

* cxxfilt: (binutils)c++filt.     MS-DOS name for c++filt.

* cxxfilt: (binutils)c++filt.     MS-DOS name for c++filt.

* dlltool: (binutils)dlltool.     Create files needed to build and use DLLs.

* dlltool: (binutils)dlltool.     Create files needed to build and use DLLs.

* nlmconv: (binutils)nlmconv.     Converts object code into an NLM.

* nlmconv: (binutils)nlmconv.     Converts object code into an NLM.

* nm: (binutils)nm.               List symbols from object files.

* nm: (binutils)nm.               List symbols from object files.

* objcopy: (binutils)objcopy.     Copy and translate object files.

* objcopy: (binutils)objcopy.     Copy and translate object files.

* objdump: (binutils)objdump.     Display information from object files.

* objdump: (binutils)objdump.     Display information from object files.

* ranlib: (binutils)ranlib.       Generate index to archive contents.

* ranlib: (binutils)ranlib.       Generate index to archive contents.

* readelf: (binutils)readelf.     Display the contents of ELF format files.

* readelf: (binutils)readelf.     Display the contents of ELF format files.

* size: (binutils)size.           List section sizes and total size.

* size: (binutils)size.           List section sizes and total size.

* strings: (binutils)strings.     List printable strings from files.

* strings: (binutils)strings.     List printable strings from files.

* strip: (binutils)strip.         Discard symbols.

* strip: (binutils)strip.         Discard symbols.

* windmc: (binutils)windmc.       Generator for Windows message resources.

* windmc: (binutils)windmc.       Generator for Windows message resources.

* windres: (binutils)windres.     Manipulate Windows resources.

* windres: (binutils)windres.     Manipulate Windows resources.

@end direntry

@end direntry

@titlepage

@titlepage

@title The @sc{gnu} Binary Utilities

@title The @sc{gnu} Binary Utilities

@ifset VERSION_PACKAGE

@ifset VERSION_PACKAGE

@subtitle @value{VERSION_PACKAGE}

@subtitle @value{VERSION_PACKAGE}

@end ifset

@end ifset

@subtitle Version @value{VERSION}

@subtitle Version @value{VERSION}

@sp 1

@sp 1

@subtitle @value{UPDATED}

@subtitle @value{UPDATED}

@author Roland H. Pesch

@author Roland H. Pesch

@author Jeffrey M. Osier

@author Jeffrey M. Osier

@author Cygnus Support

@author Cygnus Support

@page

@page

@tex

@tex

{\parskip=0pt \hfill Cygnus Support\par \hfill

{\parskip=0pt \hfill Cygnus Support\par \hfill

Texinfo \texinfoversion\par }

Texinfo \texinfoversion\par }

@end tex

@end tex

@vskip 0pt plus 1filll

@vskip 0pt plus 1filll

@insertcopying

@insertcopying

@end titlepage

@end titlepage

@contents

@contents

@node Top

@node Top

@top Introduction

@top Introduction

@cindex version

@cindex version

This brief manual contains documentation for the @sc{gnu} binary

This brief manual contains documentation for the @sc{gnu} binary

utilities

utilities

@ifset VERSION_PACKAGE

@ifset VERSION_PACKAGE

@value{VERSION_PACKAGE}

@value{VERSION_PACKAGE}

@end ifset

@end ifset

version @value{VERSION}:

version @value{VERSION}:

@iftex

@iftex

@table @code

@table @code

@item ar

@item ar

Create, modify, and extract from archives

Create, modify, and extract from archives

@item nm

@item nm

List symbols from object files

List symbols from object files

@item objcopy

@item objcopy

Copy and translate object files

Copy and translate object files

@item objdump

@item objdump

Display information from object files

Display information from object files

@item ranlib

@item ranlib

Generate index to archive contents

Generate index to archive contents

@item readelf

@item readelf

Display the contents of ELF format files.

Display the contents of ELF format files.

@item size

@item size

List file section sizes and total size

List file section sizes and total size

@item strings

@item strings

List printable strings from files

List printable strings from files

@item strip

@item strip

Discard symbols

Discard symbols

@item c++filt

@item c++filt

Demangle encoded C++ symbols (on MS-DOS, this program is named

Demangle encoded C++ symbols (on MS-DOS, this program is named

@code{cxxfilt})

@code{cxxfilt})

@item addr2line

@item addr2line

Convert addresses into file names and line numbers

Convert addresses into file names and line numbers

@item nlmconv

@item nlmconv

Convert object code into a Netware Loadable Module

Convert object code into a Netware Loadable Module

@item windres

@item windres

Manipulate Windows resources

Manipulate Windows resources

@item windmc

@item windmc

Genertor for Windows message resources

Genertor for Windows message resources

@item dlltool

@item dlltool

Create the files needed to build and use Dynamic Link Libraries

Create the files needed to build and use Dynamic Link Libraries

@end table

@end table

@end iftex

@end iftex

This document is distributed under the terms of the GNU Free

This document is distributed under the terms of the GNU Free

Documentation License.  A copy of the license is included in the

Documentation License.  A copy of the license is included in the

section entitled ``GNU Free Documentation License''.

section entitled ``GNU Free Documentation License''.

@menu

@menu

* ar::                          Create, modify, and extract from archives

* ar::                          Create, modify, and extract from archives

* nm::                          List symbols from object files

* nm::                          List symbols from object files

* objcopy::                     Copy and translate object files

* objcopy::                     Copy and translate object files

* objdump::                     Display information from object files

* objdump::                     Display information from object files

* ranlib::                      Generate index to archive contents

* ranlib::                      Generate index to archive contents

* readelf::                     Display the contents of ELF format files

* readelf::                     Display the contents of ELF format files

* size::                        List section sizes and total size

* size::                        List section sizes and total size

* strings::                     List printable strings from files

* strings::                     List printable strings from files

* strip::                       Discard symbols

* strip::                       Discard symbols

* c++filt::                     Filter to demangle encoded C++ symbols

* c++filt::                     Filter to demangle encoded C++ symbols

* cxxfilt: c++filt.             MS-DOS name for c++filt

* cxxfilt: c++filt.             MS-DOS name for c++filt

* addr2line::                   Convert addresses to file and line

* addr2line::                   Convert addresses to file and line

* nlmconv::                     Converts object code into an NLM

* nlmconv::                     Converts object code into an NLM

* windres::                     Manipulate Windows resources

* windres::                     Manipulate Windows resources

* windmc::                      Generator for Windows message resources

* windmc::                      Generator for Windows message resources

* dlltool::                     Create files needed to build and use DLLs

* dlltool::                     Create files needed to build and use DLLs

* Common Options::              Command-line options for all utilities

* Common Options::              Command-line options for all utilities

* Selecting the Target System:: How these utilities determine the target

* Selecting the Target System:: How these utilities determine the target

* Reporting Bugs::              Reporting Bugs

* Reporting Bugs::              Reporting Bugs

* GNU Free Documentation License::  GNU Free Documentation License

* GNU Free Documentation License::  GNU Free Documentation License

* Binutils Index::              Binutils Index

* Binutils Index::              Binutils Index

@end menu

@end menu

@node ar

@node ar

@chapter ar

@chapter ar

@kindex ar

@kindex ar

@cindex archives

@cindex archives

@cindex collections of files

@cindex collections of files

@c man title ar create, modify, and extract from archives

@c man title ar create, modify, and extract from archives

@smallexample

@smallexample

ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]

ar [-]@var{p}[@var{mod} [@var{relpos}] [@var{count}]] @var{archive} [@var{member}@dots{}]

ar -M [ <mri-script ]

ar -M [ <mri-script ]

@end smallexample

@end smallexample

@c man begin DESCRIPTION ar

@c man begin DESCRIPTION ar

The @sc{gnu} @command{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

archives.  An @dfn{archive} is a single file holding a collection of

other files in a structure that makes it possible to retrieve

other files in a structure that makes it possible to retrieve

the original individual files (called @dfn{members} of the archive).

the original individual files (called @dfn{members} of the archive).

The original files' contents, mode (permissions), timestamp, owner, and

The original files' contents, mode (permissions), timestamp, owner, and

group are preserved in the archive, and can be restored on

group are preserved in the archive, and can be restored on

extraction.

extraction.

@cindex name length

@cindex name length

@sc{gnu} @command{ar} can maintain archives whose members have names of any

@sc{gnu} @command{ar} can maintain archives whose members have names of any

length; however, depending on how @command{ar} is configured on your

length; however, depending on how @command{ar} is configured on your

system, a limit on member-name length may be imposed for compatibility

system, a limit on member-name length may be imposed for compatibility

with archive formats maintained with other tools.  If it exists, the

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

limit is often 15 characters (typical of formats related to a.out) or 16

characters (typical of formats related to coff).

characters (typical of formats related to coff).

@cindex libraries

@cindex libraries

@command{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

are most often used as @dfn{libraries} holding commonly needed

subroutines.

subroutines.

@cindex symbol index

@cindex symbol index

@command{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}.

object modules in the archive when you specify the modifier @samp{s}.

Once created, this index is updated in the archive whenever @command{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).

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

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

allows routines in the library to call each other without regard to

their placement in the archive.

their placement in the archive.

You may use @samp{nm -s} or @samp{nm --print-armap} to list this index

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 @command{ar} called

table.  If an archive lacks the table, another form of @command{ar} called

@command{ranlib} can be used to add just the table.

@command{ranlib} can be used to add just the table.

@cindex thin archives

@cindex thin archives

@sc{gnu} @command{ar} can optionally create a @emph{thin} archive,

@sc{gnu} @command{ar} can optionally create a @emph{thin} archive,

which contains a symbol index and references to the original copies

which contains a symbol index and references to the original copies

of the member files of the archives.  Such an archive is useful

of the member files of the archives.  Such an archive is useful

for building libraries for use within a local build, where the

for building libraries for use within a local build, where the

relocatable objects are expected to remain available, and copying the

relocatable objects are expected to remain available, and copying the

contents of each object would only waste time and space.  Thin archives

contents of each object would only waste time and space.  Thin archives

are also @emph{flattened}, so that adding one or more archives to a

are also @emph{flattened}, so that adding one or more archives to a

thin archive will add the elements of the nested archive individually.

thin archive will add the elements of the nested archive individually.

The paths to the elements of the archive are stored relative to the

The paths to the elements of the archive are stored relative to the

archive itself.

archive itself.

@cindex compatibility, @command{ar}

@cindex compatibility, @command{ar}

@cindex @command{ar} compatibility

@cindex @command{ar} compatibility

@sc{gnu} @command{ar} is designed to be compatible with two different

@sc{gnu} @command{ar} is designed to be compatible with two different

facilities.  You can control its activity using command-line options,

facilities.  You can control its activity using command-line options,

like the different varieties of @command{ar} on Unix systems; or, if you

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

specify the single command-line option @option{-M}, you can control it

with a script supplied via standard input, like the MRI ``librarian''

with a script supplied via standard input, like the MRI ``librarian''

program.

program.

@c man end

@c man end

@menu

@menu

* ar cmdline::                  Controlling @command{ar} on the command line

* ar cmdline::                  Controlling @command{ar} on the command line

* ar scripts::                  Controlling @command{ar} with a script

* ar scripts::                  Controlling @command{ar} with a script

@end menu

@end menu

@page

@page

@node ar cmdline

@node ar cmdline

@section Controlling @command{ar} on the Command Line

@section Controlling @command{ar} on the Command Line

@smallexample

@smallexample

@c man begin SYNOPSIS ar

@c man begin SYNOPSIS ar

ar [@option{-X32_64}] [@option{-}]@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

@c man end

@end smallexample

@end smallexample

@cindex Unix compatibility, @command{ar}

@cindex Unix compatibility, @command{ar}

When you use @command{ar} in the Unix style, @command{ar} insists on at least two

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}

arguments to execute: one keyletter specifying the @emph{operation}

(optionally accompanied by other keyletters specifying

(optionally accompanied by other keyletters specifying

@emph{modifiers}), and the archive name to act on.

@emph{modifiers}), and the archive name to act on.

Most operations can also accept further @var{member} arguments,

Most operations can also accept further @var{member} arguments,

specifying particular files to operate on.

specifying particular files to operate on.

@c man begin OPTIONS ar

@c man begin OPTIONS ar

@sc{gnu} @command{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.

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

If you wish, you may begin the first command-line argument with a

dash.

dash.

@cindex operations on archive

@cindex operations on archive

The @var{p} keyletter specifies what operation to execute; it may be

The @var{p} keyletter specifies what operation to execute; it may be

any of the following, but you must specify only one of them:

any of the following, but you must specify only one of them:

@table @samp

@table @samp

@item d

@item d

@cindex deleting from archive

@cindex deleting from archive

@emph{Delete} modules from the archive.  Specify the names of modules to

@emph{Delete} modules from the archive.  Specify the names of modules to

be deleted as @var{member}@dots{}; the archive is untouched if you

be deleted as @var{member}@dots{}; the archive is untouched if you

specify no files to delete.

specify no files to delete.

If you specify the @samp{v} modifier, @command{ar} lists each module

If you specify the @samp{v} modifier, @command{ar} lists each module

as it is deleted.

as it is deleted.

@item m

@item m

@cindex moving in archive

@cindex moving in archive

Use this operation to @emph{move} members in an archive.

Use this operation to @emph{move} members in an archive.

The ordering of members in an archive can make a difference in how

The ordering of members in an archive can make a difference in how

programs are linked using the library, if a symbol is defined in more

programs are linked using the library, if a symbol is defined in more

than one member.

than one member.

If no modifiers are used with @code{m}, any members you name in the

If no modifiers are used with @code{m}, any members you name in the

@var{member} arguments are moved to the @emph{end} of the archive;

@var{member} arguments are moved to the @emph{end} of the archive;

you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a

you can use the @samp{a}, @samp{b}, or @samp{i} modifiers to move them to a

specified place instead.

specified place instead.

@item p

@item p

@cindex printing from archive

@cindex printing from archive

@emph{Print} the specified members of the archive, to the standard

@emph{Print} the specified members of the archive, to the standard

output file.  If the @samp{v} modifier is specified, show the member

output file.  If the @samp{v} modifier is specified, show the member

name before copying its contents to standard output.

name before copying its contents to standard output.

If you specify no @var{member} arguments, all the files in the archive are

If you specify no @var{member} arguments, all the files in the archive are

printed.

printed.

@item q

@item q

@cindex quick append to archive

@cindex quick append to archive

@emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of

@emph{Quick append}; Historically, add the files @var{member}@dots{} to the end of

@var{archive}, without checking for replacement.

@var{archive}, without checking for replacement.

The modifiers @samp{a}, @samp{b}, and @samp{i} do @emph{not} affect this

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.

operation; new members are always placed at the end of the archive.

The modifier @samp{v} makes @command{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

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

index is not updated, even if it already existed; you can use @samp{ar s} or

@command{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

However, too many different systems assume quick append rebuilds the

index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.

index, so @sc{gnu} @command{ar} implements @samp{q} as a synonym for @samp{r}.

@item r

@item r

@cindex replacement in archive

@cindex replacement in archive

Insert the files @var{member}@dots{} into @var{archive} (with

Insert the files @var{member}@dots{} into @var{archive} (with

@emph{replacement}). This operation differs from @samp{q} in that any

@emph{replacement}). This operation differs from @samp{q} in that any

previously existing members are deleted if their names match those being

previously existing members are deleted if their names match those being

added.

added.

If one of the files named in @var{member}@dots{} does not exist, @command{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

displays an error message, and leaves undisturbed any existing members

of the archive matching that name.

of the archive matching that name.

By default, new members are added at the end of the file; but you may

By default, new members are added at the end of the file; but you may

use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request

use one of the modifiers @samp{a}, @samp{b}, or @samp{i} to request

placement relative to some existing member.

placement relative to some existing member.

The modifier @samp{v} used with this operation elicits a line of

The modifier @samp{v} used with this operation elicits a line of

output for each file inserted, along with one of the letters @samp{a} or

output for each file inserted, along with one of the letters @samp{a} or

@samp{r} to indicate whether the file was appended (no old member

@samp{r} to indicate whether the file was appended (no old member

deleted) or replaced.

deleted) or replaced.

@item t

@item t

@cindex contents of archive

@cindex contents of archive

Display a @emph{table} listing the contents of @var{archive}, or those

Display a @emph{table} listing the contents of @var{archive}, or those

of the files listed in @var{member}@dots{} that are present in the

of the files listed in @var{member}@dots{} that are present in the

archive.  Normally only the member name is shown; if you also want to

archive.  Normally only the member name is shown; if you also want to

see the modes (permissions), timestamp, owner, group, and size, you can

see the modes (permissions), timestamp, owner, group, and size, you can

request that by also specifying the @samp{v} modifier.

request that by also specifying the @samp{v} modifier.

If you do not specify a @var{member}, all files in the archive

If you do not specify a @var{member}, all files in the archive

are listed.

are listed.

@cindex repeated names in archive

@cindex repeated names in archive

@cindex name duplication in archive

@cindex name duplication in archive

If there is more than one file with the same name (say, @samp{fie}) in

If there is more than one file with the same name (say, @samp{fie}) in

an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the

an archive (say @samp{b.a}), @samp{ar t b.a fie} lists only the

first instance; to see them all, you must ask for a complete

first instance; to see them all, you must ask for a complete

listing---in our example, @samp{ar t b.a}.

listing---in our example, @samp{ar t b.a}.

@c WRS only; per Gumby, this is implementation-dependent, and in a more

@c WRS only; per Gumby, this is implementation-dependent, and in a more

@c recent case in fact works the other way.

@c recent case in fact works the other way.

@item x

@item x

@cindex extract from archive

@cindex extract from archive

@emph{Extract} members (named @var{member}) from the archive.  You can

@emph{Extract} members (named @var{member}) from the archive.  You can

use the @samp{v} modifier with this operation, to request that

use the @samp{v} modifier with this operation, to request that

@command{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

If you do not specify a @var{member}, all files in the archive

are extracted.

are extracted.

Files cannot be extracted from a thin archive.

Files cannot be extracted from a thin archive.

@end table

@end table

A number of modifiers (@var{mod}) may immediately follow the @var{p}

A number of modifiers (@var{mod}) may immediately follow the @var{p}

keyletter, to specify variations on an operation's behavior:

keyletter, to specify variations on an operation's behavior:

@table @samp

@table @samp

@item a

@item a

@cindex relative placement in archive

@cindex relative placement in archive

Add new files @emph{after} an existing member of the

Add new files @emph{after} an existing member of the

archive.  If you use the modifier @samp{a}, the name of an existing archive

archive.  If you use the modifier @samp{a}, the name of an existing archive

member must be present as the @var{relpos} argument, before the

member must be present as the @var{relpos} argument, before the

@var{archive} specification.

@var{archive} specification.

@item b

@item b

Add new files @emph{before} an existing member of the

Add new files @emph{before} an existing member of the

archive.  If you use the modifier @samp{b}, the name of an existing archive

archive.  If you use the modifier @samp{b}, the name of an existing archive

member must be present as the @var{relpos} argument, before the

member must be present as the @var{relpos} argument, before the

@var{archive} specification.  (same as @samp{i}).

@var{archive} specification.  (same as @samp{i}).

@item c

@item c

@cindex creating archives

@cindex creating archives

@emph{Create} the archive.  The specified @var{archive} is always

@emph{Create} the archive.  The specified @var{archive} is always

created if it did not exist, when you request an update.  But a warning is

created if it did not exist, when you request an update.  But a warning is

issued unless you specify in advance that you expect to create it, by

issued unless you specify in advance that you expect to create it, by

using this modifier.

using this modifier.

@item f

@item f

Truncate names in the archive.  @sc{gnu} @command{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

names of any length.  This will cause it to create archives which are

not compatible with the native @command{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

this is a concern, the @samp{f} modifier may be used to truncate file

names when putting them in the archive.

names when putting them in the archive.

@item i

@item i

Insert new files @emph{before} an existing member of the

Insert new files @emph{before} an existing member of the

archive.  If you use the modifier @samp{i}, the name of an existing archive

archive.  If you use the modifier @samp{i}, the name of an existing archive

member must be present as the @var{relpos} argument, before the

member must be present as the @var{relpos} argument, before the

@var{archive} specification.  (same as @samp{b}).

@var{archive} specification.  (same as @samp{b}).

@item l

@item l

This modifier is accepted but not used.

This modifier is accepted but not used.

@c whaffor ar l modifier??? presumably compat; with

@c whaffor ar l modifier??? presumably compat; with

@c what???---doc@@cygnus.com, 25jan91

@c what???---doc@@cygnus.com, 25jan91

@item N

@item N

Uses the @var{count} parameter.  This is used if there are multiple

Uses the @var{count} parameter.  This is used if there are multiple

entries in the archive with the same name.  Extract or delete instance

entries in the archive with the same name.  Extract or delete instance

@var{count} of the given name from the archive.

@var{count} of the given name from the archive.

@item o

@item o

@cindex dates in archive

@cindex dates in archive

Preserve the @emph{original} dates of members when extracting them.  If

Preserve the @emph{original} dates of members when extracting them.  If

you do not specify this modifier, files extracted from the archive

you do not specify this modifier, files extracted from the archive

are stamped with the time of extraction.

are stamped with the time of extraction.

@item P

@item P

Use the full path name when matching names in the archive.  @sc{gnu}

Use the full path name when matching names in the archive.  @sc{gnu}

@command{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

are not POSIX complaint), but other archive creators can.  This option

will cause @sc{gnu} @command{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

name, which can be convenient when extracting a single file from an

archive created by another tool.

archive created by another tool.

@item s

@item s

@cindex writing archive index

@cindex writing archive index

Write an object-file index into the archive, or update an existing one,

Write an object-file index into the archive, or update an existing one,

even if no other change is made to the archive.  You may use this modifier

even if no other change is made to the archive.  You may use this modifier

flag either with any operation, or alone.  Running @samp{ar s} on an

flag either with any operation, or alone.  Running @samp{ar s} on an

archive is equivalent to running @samp{ranlib} on it.

archive is equivalent to running @samp{ranlib} on it.

@item S

@item S

@cindex not writing archive index

@cindex not writing archive index

Do not generate an archive symbol table.  This can speed up building a

Do not generate an archive symbol table.  This can speed up building a

large library in several steps.  The resulting archive can not be used

large library in several steps.  The resulting archive can not be used

with the linker.  In order to build a symbol table, you must omit the

with the linker.  In order to build a symbol table, you must omit the

@samp{S} modifier on the last execution of @samp{ar}, or you must run

@samp{S} modifier on the last execution of @samp{ar}, or you must run

@samp{ranlib} on the archive.

@samp{ranlib} on the archive.

@item T

@item T

@cindex creating thin archive

@cindex creating thin archive

Make the specified @var{archive} a @emph{thin} archive.  If it already

Make the specified @var{archive} a @emph{thin} archive.  If it already

exists and is a regular archive, the existing members must be present

exists and is a regular archive, the existing members must be present

in the same directory as @var{archive}.

in the same directory as @var{archive}.

@item u

@item u

@cindex updating an archive

@cindex updating an archive

Normally, @samp{ar r}@dots{} inserts all files

Normally, @samp{ar r}@dots{} inserts all files

listed into the archive.  If you would like to insert @emph{only} those

listed into the archive.  If you would like to insert @emph{only} those

of the files you list that are newer than existing members of the same

of the files you list that are newer than existing members of the same

names, use this modifier.  The @samp{u} modifier is allowed only for the

names, use this modifier.  The @samp{u} modifier is allowed only for the

operation @samp{r} (replace).  In particular, the combination @samp{qu} is

operation @samp{r} (replace).  In particular, the combination @samp{qu} is

not allowed, since checking the timestamps would lose any speed

not allowed, since checking the timestamps would lose any speed

advantage from the operation @samp{q}.

advantage from the operation @samp{q}.

@item v

@item v

This modifier requests the @emph{verbose} version of an operation.  Many

This modifier requests the @emph{verbose} version of an operation.  Many

operations display additional information, such as filenames processed,

operations display additional information, such as filenames processed,

when the modifier @samp{v} is appended.

when the modifier @samp{v} is appended.

@item V

@item V

This modifier shows the version number of @command{ar}.

This modifier shows the version number of @command{ar}.

@end table

@end table

@command{ar} ignores an initial option spelt @samp{-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

compatibility with AIX.  The behaviour produced by this option is the

default for @sc{gnu} @command{ar}.  @command{ar} does not support any of the other

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}

@samp{-X} options; in particular, it does not support @option{-X32}

which is the default for AIX @command{ar}.

which is the default for AIX @command{ar}.

@c man end

@c man end

@ignore

@ignore

@c man begin SEEALSO ar

@c man begin SEEALSO ar

nm(1), ranlib(1), and the Info entries for @file{binutils}.

nm(1), ranlib(1), and the Info entries for @file{binutils}.

@c man end

@c man end

@end ignore

@end ignore

@node ar scripts

@node ar scripts

@section Controlling @command{ar} with a Script

@section Controlling @command{ar} with a Script

@smallexample

@smallexample

ar -M [ <@var{script} ]

ar -M [ <@var{script} ]

@end smallexample

@end smallexample

@cindex MRI compatibility, @command{ar}

@cindex MRI compatibility, @command{ar}

@cindex scripts, @command{ar}

@cindex scripts, @command{ar}

If you use the single command-line option @samp{-M} with @command{ar}, you

If you use the single command-line option @samp{-M} with @command{ar}, you

can control its operation with a rudimentary command language.  This

can control its operation with a rudimentary command language.  This

form of @command{ar} operates interactively if standard input is coming

form of @command{ar} operates interactively if standard input is coming

directly from a terminal.  During interactive use, @command{ar} prompts for

directly from a terminal.  During interactive use, @command{ar} prompts for

input (the prompt is @samp{AR >}), and continues executing even after

input (the prompt is @samp{AR >}), and continues executing even after

errors.  If you redirect standard input to a script file, no prompts are

errors.  If you redirect standard input to a script file, no prompts are

issued, and @command{ar} abandons execution (with a nonzero exit code)

issued, and @command{ar} abandons execution (with a nonzero exit code)

on any error.

on any error.

The @command{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

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

over archives.  The only purpose of the command language is to ease the

transition to @sc{gnu} @command{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.

written for the MRI ``librarian'' program.

The syntax for the @command{ar} command language is straightforward:

The syntax for the @command{ar} command language is straightforward:

@itemize @bullet

@itemize @bullet

@item

@item

commands are recognized in upper or lower case; for example, @code{LIST}

commands are recognized in upper or lower case; for example, @code{LIST}

is the same as @code{list}.  In the following descriptions, commands are

is the same as @code{list}.  In the following descriptions, commands are

shown in upper case for clarity.

shown in upper case for clarity.

@item

@item

a single command may appear on each line; it is the first word on the

a single command may appear on each line; it is the first word on the

line.

line.

@item

@item

empty lines are allowed, and have no effect.

empty lines are allowed, and have no effect.

@item

@item

comments are allowed; text after either of the characters @samp{*}

comments are allowed; text after either of the characters @samp{*}

or @samp{;} is ignored.

or @samp{;} is ignored.

@item

@item

Whenever you use a list of names as part of the argument to an @command{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

command, you can separate the individual names with either commas or

blanks.  Commas are shown in the explanations below, for clarity.

blanks.  Commas are shown in the explanations below, for clarity.

@item

@item

@samp{+} is used as a line continuation character; if @samp{+} appears

@samp{+} is used as a line continuation character; if @samp{+} appears

at the end of a line, the text on the following line is considered part

at the end of a line, the text on the following line is considered part

of the current command.

of the current command.

@end itemize

@end itemize

Here are the commands you can use in @command{ar} scripts, or when using

Here are the commands you can use in @command{ar} scripts, or when using

@command{ar} interactively.  Three of them have special significance:

@command{ar} interactively.  Three of them have special significance:

@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is

@code{OPEN} or @code{CREATE} specify a @dfn{current archive}, which is

a temporary file required for most of the other commands.

a temporary file required for most of the other commands.

@code{SAVE} commits the changes so far specified by the script.  Prior

@code{SAVE} commits the changes so far specified by the script.  Prior

to @code{SAVE}, commands affect only the temporary copy of the current

to @code{SAVE}, commands affect only the temporary copy of the current

archive.

archive.

@table @code

@table @code

@item ADDLIB @var{archive}

@item ADDLIB @var{archive}

@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})

@itemx ADDLIB @var{archive} (@var{module}, @var{module}, @dots{} @var{module})

Add all the contents of @var{archive} (or, if specified, each named

Add all the contents of @var{archive} (or, if specified, each named

@var{module} from @var{archive}) to the current archive.

@var{module} from @var{archive}) to the current archive.

Requires prior use of @code{OPEN} or @code{CREATE}.

Requires prior use of @code{OPEN} or @code{CREATE}.

@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}

@item ADDMOD @var{member}, @var{member}, @dots{} @var{member}

@c FIXME! w/Replacement??  If so, like "ar r @var{archive} @var{names}"

@c FIXME! w/Replacement??  If so, like "ar r @var{archive} @var{names}"

@c        else like "ar q..."

@c        else like "ar q..."

Add each named @var{member} as a module in the current archive.

Add each named @var{member} as a module in the current archive.

Requires prior use of @code{OPEN} or @code{CREATE}.

Requires prior use of @code{OPEN} or @code{CREATE}.

@item CLEAR

@item CLEAR

Discard the contents of the current archive, canceling the effect of

Discard the contents of the current archive, canceling the effect of

any operations since the last @code{SAVE}.  May be executed (with no

any operations since the last @code{SAVE}.  May be executed (with no

effect) even if  no current archive is specified.

effect) even if  no current archive is specified.

@item CREATE @var{archive}

@item CREATE @var{archive}

Creates an archive, and makes it the current archive (required for many

Creates an archive, and makes it the current archive (required for many

other commands).  The new archive is created with a temporary name; it

other commands).  The new archive is created with a temporary name; it

is not actually saved as @var{archive} until you use @code{SAVE}.

is not actually saved as @var{archive} until you use @code{SAVE}.

You can overwrite existing archives; similarly, the contents of any

You can overwrite existing archives; similarly, the contents of any

existing file named @var{archive} will not be destroyed until @code{SAVE}.

existing file named @var{archive} will not be destroyed until @code{SAVE}.

@item DELETE @var{module}, @var{module}, @dots{} @var{module}

@item DELETE @var{module}, @var{module}, @dots{} @var{module}

Delete each listed @var{module} from the current archive; equivalent to

Delete each listed @var{module} from the current archive; equivalent to

@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.

@samp{ar -d @var{archive} @var{module} @dots{} @var{module}}.

Requires prior use of @code{OPEN} or @code{CREATE}.

Requires prior use of @code{OPEN} or @code{CREATE}.

@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})

@item DIRECTORY @var{archive} (@var{module}, @dots{} @var{module})

@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}

@itemx DIRECTORY @var{archive} (@var{module}, @dots{} @var{module}) @var{outputfile}

List each named @var{module} present in @var{archive}.  The separate

List each named @var{module} present in @var{archive}.  The separate

command @code{VERBOSE} specifies the form of the output: when verbose

command @code{VERBOSE} specifies the form of the output: when verbose

output is off, output is like that of @samp{ar -t @var{archive}

output is off, output is like that of @samp{ar -t @var{archive}

@var{module}@dots{}}.  When verbose output is on, the listing is like

@var{module}@dots{}}.  When verbose output is on, the listing is like

@samp{ar -tv @var{archive} @var{module}@dots{}}.

@samp{ar -tv @var{archive} @var{module}@dots{}}.

Output normally goes to the standard output stream; however, if you

Output normally goes to the standard output stream; however, if you

specify @var{outputfile} as a final argument, @command{ar} directs the

specify @var{outputfile} as a final argument, @command{ar} directs the

output to that file.

output to that file.

@item END

@item END

Exit from @command{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

completion.  This command does not save the output file; if you have

changed the current archive since the last @code{SAVE} command, those

changed the current archive since the last @code{SAVE} command, those

changes are lost.

changes are lost.

@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}

@item EXTRACT @var{module}, @var{module}, @dots{} @var{module}

Extract each named @var{module} from the current archive, writing them

Extract each named @var{module} from the current archive, writing them

into the current directory as separate files.  Equivalent to @samp{ar -x

into the current directory as separate files.  Equivalent to @samp{ar -x

@var{archive} @var{module}@dots{}}.

@var{archive} @var{module}@dots{}}.

Requires prior use of @code{OPEN} or @code{CREATE}.

Requires prior use of @code{OPEN} or @code{CREATE}.

@ignore

@ignore

@c FIXME Tokens but no commands???

@c FIXME Tokens but no commands???

@item FULLDIR

@item FULLDIR

@item HELP

@item HELP

@end ignore

@end ignore

@item LIST

@item LIST

Display full contents of the current archive, in ``verbose'' style

Display full contents of the current archive, in ``verbose'' style

regardless of the state of @code{VERBOSE}.  The effect is like @samp{ar

regardless of the state of @code{VERBOSE}.  The effect is like @samp{ar

tv @var{archive}}.  (This single command is a @sc{gnu} @command{ar}

tv @var{archive}}.  (This single command is a @sc{gnu} @command{ar}

enhancement, rather than present for MRI compatibility.)

enhancement, rather than present for MRI compatibility.)

Requires prior use of @code{OPEN} or @code{CREATE}.

Requires prior use of @code{OPEN} or @code{CREATE}.

@item OPEN @var{archive}

@item OPEN @var{archive}

Opens an existing archive for use as the current archive (required for

Opens an existing archive for use as the current archive (required for

many other commands).  Any changes as the result of subsequent commands

many other commands).  Any changes as the result of subsequent commands

will not actually affect @var{archive} until you next use @code{SAVE}.

will not actually affect @var{archive} until you next use @code{SAVE}.

@item REPLACE @var{module}, @var{module}, @dots{} @var{module}

@item REPLACE @var{module}, @var{module}, @dots{} @var{module}

In the current archive, replace each existing @var{module} (named in

In the current archive, replace each existing @var{module} (named in

the @code{REPLACE} arguments) from files in the current working directory.

the @code{REPLACE} arguments) from files in the current working directory.

To execute this command without errors, both the file, and the module in

To execute this command without errors, both the file, and the module in

the current archive, must exist.

the current archive, must exist.

Requires prior use of @code{OPEN} or @code{CREATE}.

Requires prior use of @code{OPEN} or @code{CREATE}.

@item VERBOSE

@item VERBOSE

Toggle an internal flag governing the output from @code{DIRECTORY}.

Toggle an internal flag governing the output from @code{DIRECTORY}.

When the flag is on, @code{DIRECTORY} output matches output from

When the flag is on, @code{DIRECTORY} output matches output from

@samp{ar -tv }@dots{}.

@samp{ar -tv }@dots{}.

@item SAVE

@item SAVE

Commit your changes to the current archive, and actually save it as a

Commit your changes to the current archive, and actually save it as a

file with the name specified in the last @code{CREATE} or @code{OPEN}

file with the name specified in the last @code{CREATE} or @code{OPEN}

command.

command.

Requires prior use of @code{OPEN} or @code{CREATE}.

Requires prior use of @code{OPEN} or @code{CREATE}.

@end table

@end table

@iftex

@iftex

@node ld

@node ld

@chapter ld

@chapter ld

@cindex linker

@cindex linker

@kindex ld

@kindex ld

The @sc{gnu} linker @command{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}.

@xref{Top,, Overview,, Using LD: the @sc{gnu} linker}.

@end iftex

@end iftex

@node nm

@node nm

@chapter nm

@chapter nm

@cindex symbols

@cindex symbols

@kindex nm

@kindex nm

@c man title nm list symbols from object files

@c man title nm list symbols from object files

@smallexample

@smallexample

@c man begin SYNOPSIS nm

@c man begin SYNOPSIS nm

nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]

nm [@option{-a}|@option{--debug-syms}] [@option{-g}|@option{--extern-only}]

   [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]

   [@option{-B}] [@option{-C}|@option{--demangle}[=@var{style}]] [@option{-D}|@option{--dynamic}]

   [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]

   [@option{-S}|@option{--print-size}] [@option{-s}|@option{--print-armap}]

   [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]

   [@option{-A}|@option{-o}|@option{--print-file-name}][@option{--special-syms}]

   [@option{-n}|@option{-v}|@option{--numeric-sort}] [@option{-p}|@option{--no-sort}]

   [@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{-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{-t} @var{radix}|@option{--radix=}@var{radix}] [@option{-P}|@option{--portability}]

   [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]

   [@option{--target=}@var{bfdname}] [@option{-f}@var{format}|@option{--format=}@var{format}]

   [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]

   [@option{--defined-only}] [@option{-l}|@option{--line-numbers}] [@option{--no-demangle}]

   [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}]  [@var{objfile}@dots{}]

   [@option{-V}|@option{--version}] [@option{-X 32_64}] [@option{--help}]  [@var{objfile}@dots{}]

@c man end

@c man end

@end smallexample

@end smallexample

@c man begin DESCRIPTION nm

@c man begin DESCRIPTION nm

@sc{gnu} @command{nm} lists the symbols from object files @var{objfile}@dots{}.

@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

If no object files are listed as arguments, @command{nm} assumes the file

@file{a.out}.

@file{a.out}.

For each symbol, @command{nm} shows:

For each symbol, @command{nm} shows:

@itemize @bullet

@itemize @bullet

@item

@item

The symbol value, in the radix selected by options (see below), or

The symbol value, in the radix selected by options (see below), or

hexadecimal by default.

hexadecimal by default.

@item

@item

The symbol type.  At least the following types are used; others are, as

The symbol type.  At least the following types are used; others are, as

well, depending on the object file format.  If lowercase, the symbol is

well, depending on the object file format.  If lowercase, the symbol is

local; if uppercase, the symbol is global (external).

local; if uppercase, the symbol is global (external).

@c Some more detail on exactly what these symbol types are used for

@c Some more detail on exactly what these symbol types are used for

@c would be nice.

@c would be nice.

@table @code

@table @code

@item A

@item A

The symbol's value is absolute, and will not be changed by further

The symbol's value is absolute, and will not be changed by further

linking.

linking.

@item B

@item B

@itemx b

@itemx b

The symbol is in the uninitialized data section (known as BSS).

The symbol is in the uninitialized data section (known as BSS).

@item C

@item C

The symbol is common.  Common symbols are uninitialized data.  When

The symbol is common.  Common symbols are uninitialized data.  When

linking, multiple common symbols may appear with the same name.  If the

linking, multiple common symbols may appear with the same name.  If the

symbol is defined anywhere, the common symbols are treated as undefined

symbol is defined anywhere, the common symbols are treated as undefined

references.

references.

@ifclear man

@ifclear man

For more details on common symbols, see the discussion of

For more details on common symbols, see the discussion of

--warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.

--warn-common in @ref{Options,,Linker options,ld.info,The GNU linker}.

@end ifclear

@end ifclear

@item D

@item D

@itemx d

@itemx d

The symbol is in the initialized data section.

The symbol is in the initialized data section.

@item G

@item G

@itemx g

@itemx g

The symbol is in an initialized data section for small objects.  Some

The symbol is in an initialized data section for small objects.  Some

object file formats permit more efficient access to small data objects,

object file formats permit more efficient access to small data objects,

such as a global int variable as opposed to a large global array.

such as a global int variable as opposed to a large global array.

@item I

@item I

The symbol is an indirect reference to another symbol.  This is a @sc{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.

extension to the a.out object file format which is rarely used.

@item i

@item i

The symbol is in a section specific to the implementation of DLLs.

The symbol is in a section specific to the implementation of DLLs.

@item N

@item N

The symbol is a debugging symbol.

The symbol is a debugging symbol.

@item p

@item p

The symbols is in a stack unwind section.

The symbols is in a stack unwind section.

@item R

@item R

@itemx r

@itemx r

The symbol is in a read only data section.

The symbol is in a read only data section.

@item S

@item S

@itemx s

@itemx s

The symbol is in an uninitialized data section for small objects.

The symbol is in an uninitialized data section for small objects.

@item T

@item T

@itemx t

@itemx t

The symbol is in the text (code) section.

The symbol is in the text (code) section.

@item U

@item U

The symbol is undefined.

The symbol is undefined.

@item V

@item V

@itemx v

@itemx v

The symbol is a weak object.  When a weak defined symbol is linked with

The symbol is a weak object.  When a weak defined symbol is linked with

a normal defined symbol, the normal defined symbol is used with no error.

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,

When a weak undefined symbol is linked and the symbol is not defined,

the value of the weak symbol becomes zero with no error.  On some

the value of the weak symbol becomes zero with no error.  On some

systems, uppercase indicates that a default value has been specified.

systems, uppercase indicates that a default value has been specified.

@item W

@item W

@itemx w

@itemx w

The symbol is a weak symbol that has not been specifically tagged as a

The symbol is a weak symbol that has not been specifically tagged as a

weak object symbol.  When a weak defined symbol is linked with a normal

weak object symbol.  When a weak defined symbol is linked with a normal

defined symbol, the normal defined symbol is used with no error.

defined symbol, the normal defined symbol is used with no error.

When a weak undefined symbol is linked and the symbol is not defined,

When a weak undefined symbol is linked and the symbol is not defined,

the value of the symbol is determined in a system-specific manner without

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

error.  On some systems, uppercase indicates that a default value has been

specified.

specified.

@item -

@item -

The symbol is a stabs symbol in an a.out object file.  In this case, the

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

next values printed are the stabs other field, the stabs desc field, and

the stab type.  Stabs symbols are used to hold debugging information.

the stab type.  Stabs symbols are used to hold debugging information.

@ifclear man

@ifclear man

For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The

For more information, see @ref{Top,Stabs,Stabs Overview,stabs.info, The

``stabs'' debug format}.

``stabs'' debug format}.

@end ifclear

@end ifclear

@item ?

@item ?

The symbol type is unknown, or object file format specific.

The symbol type is unknown, or object file format specific.

@end table

@end table

@item

@item

The symbol name.

The symbol name.

@end itemize

@end itemize

@c man end

@c man end

@c man begin OPTIONS nm

@c man begin OPTIONS nm

The long and short forms of options, shown here as alternatives, are

The long and short forms of options, shown here as alternatives, are

equivalent.

equivalent.

@table @env

@table @env

@item -A

@item -A

@itemx -o

@itemx -o

@itemx --print-file-name

@itemx --print-file-name

@cindex input file name

@cindex input file name

@cindex file name

@cindex file name

@cindex source file name

@cindex source file name

Precede each symbol by the name of the input file (or archive member)

Precede each symbol by the name of the input file (or archive member)

in which it was found, rather than identifying the input file once only,

in which it was found, rather than identifying the input file once only,

before all of its symbols.

before all of its symbols.

@item -a

@item -a

@itemx --debug-syms

@itemx --debug-syms

@cindex debugging symbols

@cindex debugging symbols

Display all symbols, even debugger-only symbols; normally these are not

Display all symbols, even debugger-only symbols; normally these are not

listed.

listed.

@item -B

@item -B

@cindex @command{nm} format

@cindex @command{nm} format

@cindex @command{nm} compatibility

@cindex @command{nm} compatibility

The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).

The same as @option{--format=bsd} (for compatibility with the MIPS @command{nm}).

@item -C

@item -C

@itemx --demangle[=@var{style}]

@itemx --demangle[=@var{style}]

@cindex demangling in nm

@cindex demangling in nm

Decode (@dfn{demangle}) low-level symbol names into user-level names.

Decode (@dfn{demangle}) low-level symbol names into user-level names.

Besides removing any initial underscore prepended by the system, this

Besides removing any initial underscore prepended by the system, this

makes C++ function names readable. Different compilers have different

makes C++ function names readable. Different compilers have different

mangling styles. The optional demangling style argument can be used to

mangling styles. The optional demangling style argument can be used to

choose an appropriate demangling style for your compiler. @xref{c++filt},

choose an appropriate demangling style for your compiler. @xref{c++filt},

for more information on demangling.

for more information on demangling.

@item --no-demangle

@item --no-demangle

Do not demangle low-level symbol names.  This is the default.

Do not demangle low-level symbol names.  This is the default.

@item -D

@item -D

@itemx --dynamic

@itemx --dynamic

@cindex dynamic symbols

@cindex dynamic symbols

Display the dynamic symbols rather than the normal symbols.  This is

Display the dynamic symbols rather than the normal symbols.  This is

only meaningful for dynamic objects, such as certain types of shared

only meaningful for dynamic objects, such as certain types of shared

libraries.

libraries.

@item -f @var{format}

@item -f @var{format}

@itemx --format=@var{format}

@itemx --format=@var{format}

@cindex @command{nm} format

@cindex @command{nm} format

@cindex @command{nm} compatibility

@cindex @command{nm} compatibility

Use the output format @var{format}, which can be @code{bsd},

Use the output format @var{format}, which can be @code{bsd},

@code{sysv}, or @code{posix}.  The default is @code{bsd}.

@code{sysv}, or @code{posix}.  The default is @code{bsd}.

Only the first character of @var{format} is significant; it can be

Only the first character of @var{format} is significant; it can be

either upper or lower case.

either upper or lower case.

@item -g

@item -g

@itemx --extern-only

@itemx --extern-only

@cindex external symbols

@cindex external symbols

Display only external symbols.

Display only external symbols.

@item -l

@item -l

@itemx --line-numbers

@itemx --line-numbers

@cindex symbol line numbers

@cindex symbol line numbers

For each symbol, use debugging information to try to find a filename and

For each symbol, use debugging information to try to find a filename and

line number.  For a defined symbol, look for the line number of the

line number.  For a defined symbol, look for the line number of the

address of the symbol.  For an undefined symbol, look for the line

address of the symbol.  For an undefined symbol, look for the line

number of a relocation entry which refers to the symbol.  If line number

number of a relocation entry which refers to the symbol.  If line number

information can be found, print it after the other symbol information.

information can be found, print it after the other symbol information.

@item -n

@item -n

@itemx -v

@itemx -v

@itemx --numeric-sort

@itemx --numeric-sort

Sort symbols numerically by their addresses, rather than alphabetically

Sort symbols numerically by their addresses, rather than alphabetically

by their names.

by their names.

@item -p

@item -p

@itemx --no-sort

@itemx --no-sort

@cindex sorting symbols

@cindex sorting symbols

Do not bother to sort the symbols in any order; print them in the order

Do not bother to sort the symbols in any order; print them in the order

encountered.

encountered.

@item -P

@item -P

@itemx --portability

@itemx --portability

Use the POSIX.2 standard output format instead of the default format.

Use the POSIX.2 standard output format instead of the default format.

Equivalent to @samp{-f posix}.

Equivalent to @samp{-f posix}.

@item -S

@item -S

@itemx --print-size

@itemx --print-size

Print size, not the value, of defined symbols for the @code{bsd} output format.

Print size, not the value, of defined symbols for the @code{bsd} output format.

@item -s

@item -s

@itemx --print-armap

@itemx --print-armap

@cindex symbol index, listing

@cindex symbol index, listing

When listing symbols from archive members, include the index: a mapping

When listing symbols from archive members, include the index: a mapping

(stored in the archive by @command{ar} or @command{ranlib}) of which modules

(stored in the archive by @command{ar} or @command{ranlib}) of which modules

contain definitions for which names.

contain definitions for which names.

@item -r

@item -r

@itemx --reverse-sort

@itemx --reverse-sort

Reverse the order of the sort (whether numeric or alphabetic); let the

Reverse the order of the sort (whether numeric or alphabetic); let the

last come first.

last come first.

@item --size-sort

@item --size-sort

Sort symbols by size.  The size is computed as the difference between

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

the value of the symbol and the value of the symbol with the next higher

value.  If the @code{bsd} output format is used the size of the symbol

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

is printed, rather than the value, and @samp{-S} must be used in order

both size and value to be printed.

both size and value to be printed.

@item --special-syms

@item --special-syms

Display symbols which have a target-specific special meaning.  These

Display symbols which have a target-specific special meaning.  These

symbols are usually used by the target for some special processing and

symbols are usually used by the target for some special processing and

are not normally helpful when included included in the normal symbol

are not normally helpful when included included in the normal symbol

lists.  For example for ARM targets this option would skip the mapping

lists.  For example for ARM targets this option would skip the mapping

symbols used to mark transitions between ARM code, THUMB code and

symbols used to mark transitions between ARM code, THUMB code and

data.

data.

@item -t @var{radix}

@item -t @var{radix}

@itemx --radix=@var{radix}

@itemx --radix=@var{radix}

Use @var{radix} as the radix for printing the symbol values.  It must be

Use @var{radix} as the radix for printing the symbol values.  It must be

@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.

@samp{d} for decimal, @samp{o} for octal, or @samp{x} for hexadecimal.

@item --target=@var{bfdname}

@item --target=@var{bfdname}

@cindex object code format

@cindex object code format

Specify an object code format other than your system's default format.

Specify an object code format other than your system's default format.

@xref{Target Selection}, for more information.

@xref{Target Selection}, for more information.

@item -u

@item -u

@itemx --undefined-only

@itemx --undefined-only

@cindex external symbols

@cindex external symbols

@cindex undefined symbols

@cindex undefined symbols

Display only undefined symbols (those external to each object file).

Display only undefined symbols (those external to each object file).

@item --defined-only

@item --defined-only

@cindex external symbols

@cindex external symbols

@cindex undefined symbols

@cindex undefined symbols

Display only defined symbols for each object file.

Display only defined symbols for each object file.

@item -V

@item -V

@itemx --version

@itemx --version

Show the version number of @command{nm} and exit.

Show the version number of @command{nm} and exit.

@item -X

@item -X

This option is ignored for compatibility with the AIX version of

This option is ignored for compatibility with the AIX version of