[deliverable/binutils-gdb.git] / binutils / objdump.1

.\" Copyright (c) 1991 Free Software Foundation
.\" See section COPYING for conditions for redistribution
.TH objdump 1 "5 November 1991" "cygnus support" "GNU Development Tools"
.de BP
.sp
.ti \-.2i
\(**
..

.SH NAME
objdump \- display information from object files.

.SH SYNOPSIS
.hy 0
.na
.TP
.B objdump
.RB "[\|" \-a | \-\-archive\-headers "\|]" 
.RB "[\|" "\-b\ "\c
.I bfdname\c
.RB " | " "\-\-target="\c
.I bfdname\c
\&\|] 
.RB "[\|" \-d | \-\-disassemble "\|]" 
.RB "[\|" \-f | \-\-file\-headers "\|]"
.RB "[\|" \-h | \-\-section\-headers
.RB "| " \-\-headers "\|]" 
.RB "[\|" \-i | \-\-info "\|]" 
.RB "[\|" "\-j\ "\c
.I section\c
.RB " | " "\-\-section="\c
.I section\c
\&\|] 
.RB "[\|" \-l | \-\-line\-numbers "\|]"
.RB "[\|" "\-m\ "\c
.I machine\c
.RB " | " "\-\-architecture="\c
.I machine\c
\&\|] 
.RB "[\|" \-r | \-\-reloc "\|]" 
.RB "[\|" \-R | \-\-dynamic\-reloc "\|]" 
.RB "[\|" \-s | \-\-full\-contents "\|]"
.RB "[\|" \-\-stabs "\|]"
.RB "[\|" \-t | \-\-syms "\|]" 
.RB "[\|" \-T | \-\-dynamic\-syms "\|]" 
.RB "[\|" \-x | \-\-all\-headers "\|]"
.RB "[\|" \-\-version "\|]"
.RB "[\|" \-\-help "\|]"
.I objfile\c
\&.\|.\|.
.ad b
.hy 1
.SH DESCRIPTION
\c
.B objdump\c
\& 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.
.PP
.IR  "objfile" .\|.\|.
are the object files to be examined.  When you specify archives,
\c
.B objdump\c
\& shows information on each of the member object files.

.SH OPTIONS
Where long and short forms of an option are shown together, they are
equivalent.  At least one option besides
.B \-l
(\fB\-\-line\-numbers\fP) must be given.

.TP
.B \-a
.TP
.B \-\-archive\-headers
If any files from \c
.I objfile\c
\& are archives, display the archive
header information (in a format similar to `\|\c
.B ls \-l\c
\|').  Besides the
information you could list with `\|\c
.B ar tv\c
\|', `\|\c
.B objdump \-a\c
\|' shows
the object file format of each archive member.

.TP
.BI "\-b " "bfdname"\c
.TP
.BI "\-\-target=" "bfdname"\c
\&
Specify the object-code format for the object files to be
\c
.I bfdname\c
\&.  This may not be necessary; \c
.I objdump\c
\& can
automatically recognize many formats.  For example,
.sp
.br
objdump\ \-b\ oasys\ \-m\ vax\ \-h\ fu.o
.br
.sp

display summary information from the section headers (`\|\c
.B \-h\c
\|') of
`\|\c
.B fu.o\c
\|', which is explicitly identified (`\|\c
.B \-m\c
\|') as a Vax object
file in the format produced by Oasys compilers.  You can list the
formats available with the `\|\c
.B \-i\c
\|' option.

.TP
.B \-d
.TP
.B \-\-disassemble
Display the assembler mnemonics for the machine
instructions from \c
.I objfile\c
\&.

.TP
.B \-f
.TP
.B \-\-file\-headers
Display summary information from the overall header of
each file in \c
.I objfile\c
\&.

.TP
.B \-h
.TP
.B \-\-section\-headers
.TP
.B \-\-headers
Display summary information from the section headers of the
object file.

.TP
.B \-\-help
Print a summary of the options to
.B objdump
and exit.

.TP
.B \-i
.TP
.B \-\-info
Display a list showing all architectures and object formats available
for specification with \c
.B \-b\c
\& or \c
.B \-m\c
\&.

.TP
.BI "\-j " "name"\c
.TP
.BI "\-\-section=" "name"\c
\&
Display information only for section \c
.I name\c
\&

.TP
.B \-l
.TP
.B \-\-line\-numbers
Label the display (using debugging information) with the filename
and source line numbers corresponding to the object code shown.
Only useful with \fB\-d\fP.

.TP
.BI "\-m " "machine"\c
.TP
.BI "\-\-architecture=" "machine"\c
\&
Specify the object files \c
.I objfile\c
\& are for architecture
\c
.I machine\c
\&.  You can list available architectures using the `\|\c
.B \-i\c
\|'
option. 

.TP
.B \-r
.TP
.B \-\-reloc
Print the relocation entries of the file.

.TP
.B \-R
.TP
.B \-\-dynamic\-reloc
Print the dynamic relocation entries of the file.  This is only
meaningful for dynamic objects, such as certain types of shared
libraries.

.TP
.B \-s
.TP
.B \-\-full\-contents
Display the full contents of any sections requested.

.TP
.B \-\-stabs
Display the contents of the .stab, .stab.index, and .stab.excl
sections from an ELF file.  This is only useful on systems (such as
Solaris 2.0) in which .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
\-\-syms output.

.TP
.B \-t
.TP
.B \-\-syms
Symbol Table.  Print the symbol table entries of the file.
This is similar to the information provided by the `\|\c
.B nm\c
\|' program.

.TP
.B \-T
.TP
.B \-\-dynamic\-syms
Dynamic Symbol Table.  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 `\|\c
.B nm\c
\|' program when given the
.B \-D (\-\-dynamic)
option.

.TP
.B \-\-version
Print the version number of
.B objdump
and exit.

.TP
.B \-x
.TP
.B \-\-all\-headers
Display all available header information, including the symbol table and
relocation entries.  Using `\|\c
.B \-x\c
\|' is equivalent to specifying all of
`\|\c
.B \-a \-f \-h \-r \-t\c
\|'.

.SH "SEE ALSO"
.RB "`\|" binutils "\|'"
entry in 
.B
info\c
\&; 
.I
The GNU Binary Utilities\c
\&, Roland H. Pesch (October 1991); 
.BR nm "(" 1 ")."

.SH COPYING
Copyright (c) 1991 Free Software Foundation, Inc.
.PP
Permission is granted to make and distribute verbatim copies of
this manual provided the copyright notice and this permission notice
are preserved on all copies.
.PP
Permission is granted to copy and distribute modified versions of this
manual under the conditions for verbatim copying, provided that the
entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
.PP
Permission is granted to copy and distribute translations of this
manual into another language, under the above conditions for modified
versions, except that this permission notice may be included in
translations approved by the Free Software Foundation instead of in
the original English.
Commit	Line	Data
	1	.\" Copyright (c) 1991 Free Software Foundation
	2	.\" See section COPYING for conditions for redistribution
	3	.TH objdump 1 "5 November 1991" "cygnus support" "GNU Development Tools"
	4	.de BP
	5	.sp
	6	.ti \-.2i
	7	\(**
	8	..
	9
	10	.SH NAME
	11	objdump \- display information from object files.
	12
	13	.SH SYNOPSIS
	14	.hy 0
	15	.na
	16	.TP
	17	.B objdump
	18	.RB "[\\|" \-a \| \-\-archive\-headers "\\|]"
	19	.RB "[\\|" "\-b\ "\c
	20	.I bfdname\c
	21	.RB " \| " "\-\-target="\c
	22	.I bfdname\c
	23	\&\\|]
	24	.RB "[\\|" \-d \| \-\-disassemble "\\|]"
	25	.RB "[\\|" \-f \| \-\-file\-headers "\\|]"
	26	.RB "[\\|" \-h \| \-\-section\-headers
	27	.RB "\| " \-\-headers "\\|]"
	28	.RB "[\\|" \-i \| \-\-info "\\|]"
	29	.RB "[\\|" "\-j\ "\c
	30	.I section\c
	31	.RB " \| " "\-\-section="\c
	32	.I section\c
	33	\&\\|]
	34	.RB "[\\|" \-l \| \-\-line\-numbers "\\|]"
	35	.RB "[\\|" "\-m\ "\c
	36	.I machine\c
	37	.RB " \| " "\-\-architecture="\c
	38	.I machine\c
	39	\&\\|]
	40	.RB "[\\|" \-r \| \-\-reloc "\\|]"
	41	.RB "[\\|" \-R \| \-\-dynamic\-reloc "\\|]"
	42	.RB "[\\|" \-s \| \-\-full\-contents "\\|]"
	43	.RB "[\\|" \-\-stabs "\\|]"
	44	.RB "[\\|" \-t \| \-\-syms "\\|]"
	45	.RB "[\\|" \-T \| \-\-dynamic\-syms "\\|]"
	46	.RB "[\\|" \-x \| \-\-all\-headers "\\|]"
	47	.RB "[\\|" \-\-version "\\|]"
	48	.RB "[\\|" \-\-help "\\|]"
	49	.I objfile\c
	50	\&.\\|.\\|.
	51	.ad b
	52	.hy 1
	53	.SH DESCRIPTION
	54	\c
	55	.B objdump\c
	56	\& displays information about one or more object files.
	57	The options control what particular information to display. This
	58	information is mostly useful to programmers who are working on the
	59	compilation tools, as opposed to programmers who just want their
	60	program to compile and work.
	61	.PP
	62	.IR "objfile" .\\|.\\|.
	63	are the object files to be examined. When you specify archives,
	64	\c
	65	.B objdump\c
	66	\& shows information on each of the member object files.
	67
	68	.SH OPTIONS
	69	Where long and short forms of an option are shown together, they are
	70	equivalent. At least one option besides
	71	.B \-l
	72	(\fB\-\-line\-numbers\fP) must be given.
	73
	74	.TP
	75	.B \-a
	76	.TP
	77	.B \-\-archive\-headers
	78	If any files from \c
	79	.I objfile\c
	80	\& are archives, display the archive
	81	header information (in a format similar to `\\|\c
	82	.B ls \-l\c
	83	\\|'). Besides the
	84	information you could list with `\\|\c
	85	.B ar tv\c
	86	\\|', `\\|\c
	87	.B objdump \-a\c
	88	\\|' shows
	89	the object file format of each archive member.
	90
	91	.TP
	92	.BI "\-b " "bfdname"\c
	93	.TP
	94	.BI "\-\-target=" "bfdname"\c
	95	\&
	96	Specify the object-code format for the object files to be
	97	\c
	98	.I bfdname\c
	99	\&. This may not be necessary; \c
	100	.I objdump\c
	101	\& can
	102	automatically recognize many formats. For example,
	103	.sp
	104	.br
	105	objdump\ \-b\ oasys\ \-m\ vax\ \-h\ fu.o
	106	.br
	107	.sp
	108
	109	display summary information from the section headers (`\\|\c
	110	.B \-h\c
	111	\\|') of
	112	`\\|\c
	113	.B fu.o\c
	114	\\|', which is explicitly identified (`\\|\c
	115	.B \-m\c
	116	\\|') as a Vax object
	117	file in the format produced by Oasys compilers. You can list the
	118	formats available with the `\\|\c
	119	.B \-i\c
	120	\\|' option.
	121
	122	.TP
	123	.B \-d
	124	.TP
	125	.B \-\-disassemble
	126	Display the assembler mnemonics for the machine
	127	instructions from \c
	128	.I objfile\c
	129	\&.
	130
	131	.TP
	132	.B \-f
	133	.TP
	134	.B \-\-file\-headers
	135	Display summary information from the overall header of
	136	each file in \c
	137	.I objfile\c
	138	\&.
	139
	140	.TP
	141	.B \-h
	142	.TP
	143	.B \-\-section\-headers
	144	.TP
	145	.B \-\-headers
	146	Display summary information from the section headers of the
	147	object file.
	148
	149	.TP
	150	.B \-\-help
	151	Print a summary of the options to
	152	.B objdump
	153	and exit.
	154
	155	.TP
	156	.B \-i
	157	.TP
	158	.B \-\-info
	159	Display a list showing all architectures and object formats available
	160	for specification with \c
	161	.B \-b\c
	162	\& or \c
	163	.B \-m\c
	164	\&.
	165
	166	.TP
	167	.BI "\-j " "name"\c
	168	.TP
	169	.BI "\-\-section=" "name"\c
	170	\&
	171	Display information only for section \c
	172	.I name\c
	173	\&
	174
	175	.TP
	176	.B \-l
	177	.TP
	178	.B \-\-line\-numbers
	179	Label the display (using debugging information) with the filename
	180	and source line numbers corresponding to the object code shown.
	181	Only useful with \fB\-d\fP.
	182
	183	.TP
	184	.BI "\-m " "machine"\c
	185	.TP
	186	.BI "\-\-architecture=" "machine"\c
	187	\&
	188	Specify the object files \c
	189	.I objfile\c
	190	\& are for architecture
	191	\c
	192	.I machine\c
	193	\&. You can list available architectures using the `\\|\c
	194	.B \-i\c
	195	\\|'
	196	option.
	197
	198	.TP
	199	.B \-r
	200	.TP
	201	.B \-\-reloc
	202	Print the relocation entries of the file.
	203
	204	.TP
	205	.B \-R
	206	.TP
	207	.B \-\-dynamic\-reloc
	208	Print the dynamic relocation entries of the file. This is only
	209	meaningful for dynamic objects, such as certain types of shared
	210	libraries.
	211
	212	.TP
	213	.B \-s
	214	.TP
	215	.B \-\-full\-contents
	216	Display the full contents of any sections requested.
	217
	218	.TP
	219	.B \-\-stabs
	220	Display the contents of the .stab, .stab.index, and .stab.excl
	221	sections from an ELF file. This is only useful on systems (such as
	222	Solaris 2.0) in which .stab debugging symbol-table entries are carried
	223	in an ELF section. In most other file formats, debugging symbol-table
	224	entries are interleaved with linkage symbols, and are visible in the
	225	\-\-syms output.
	226
	227	.TP
	228	.B \-t
	229	.TP
	230	.B \-\-syms
	231	Symbol Table. Print the symbol table entries of the file.
	232	This is similar to the information provided by the `\\|\c
	233	.B nm\c
	234	\\|' program.
	235
	236	.TP
	237	.B \-T
	238	.TP
	239	.B \-\-dynamic\-syms
	240	Dynamic Symbol Table. Print the dynamic symbol table entries of the
	241	file. This is only meaningful for dynamic objects, such as certain
	242	types of shared libraries. This is similar to the information
	243	provided by the `\\|\c
	244	.B nm\c
	245	\\|' program when given the
	246	.B \-D (\-\-dynamic)
	247	option.
	248
	249	.TP
	250	.B \-\-version
	251	Print the version number of
	252	.B objdump
	253	and exit.
	254
	255	.TP
	256	.B \-x
	257	.TP
	258	.B \-\-all\-headers
	259	Display all available header information, including the symbol table and
	260	relocation entries. Using `\\|\c
	261	.B \-x\c
	262	\\|' is equivalent to specifying all of
	263	`\\|\c
	264	.B \-a \-f \-h \-r \-t\c
	265	\\|'.
	266
	267	.SH "SEE ALSO"
	268	.RB "`\\|" binutils "\\|'"
	269	entry in
	270	.B
	271	info\c
	272	\&;
	273	.I
	274	The GNU Binary Utilities\c
	275	\&, Roland H. Pesch (October 1991);
	276	.BR nm "(" 1 ")."
	277
	278	.SH COPYING
	279	Copyright (c) 1991 Free Software Foundation, Inc.
	280	.PP
	281	Permission is granted to make and distribute verbatim copies of
	282	this manual provided the copyright notice and this permission notice
	283	are preserved on all copies.
	284	.PP
	285	Permission is granted to copy and distribute modified versions of this
	286	manual under the conditions for verbatim copying, provided that the
	287	entire resulting derived work is distributed under the terms of a
	288	permission notice identical to this one.
	289	.PP
	290	Permission is granted to copy and distribute translations of this
	291	manual into another language, under the above conditions for modified
	292	versions, except that this permission notice may be included in
	293	translations approved by the Free Software Foundation instead of in
	294	the original English.