Merge branch 'vendor/GCC44'
[dragonfly.git] / contrib / binutils-2.21 / binutils / doc / elfedit.1
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings.  \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
29 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 .    ds -- \(*W-
36 .    ds PI pi
37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
39 .    ds L" ""
40 .    ds R" ""
41 .    ds C` ""
42 .    ds C' ""
43 'br\}
44 .el\{\
45 .    ds -- \|\(em\|
46 .    ds PI \(*p
47 .    ds L" ``
48 .    ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el       .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD.  Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 .    de IX
61 .    tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 .    nr % 0
64 .    rr F
65 .\}
66 .el \{\
67 .    de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
73 .    \" fudge factors for nroff and troff
74 .if n \{\
75 .    ds #H 0
76 .    ds #V .8m
77 .    ds #F .3m
78 .    ds #[ \f1
79 .    ds #] \fP
80 .\}
81 .if t \{\
82 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 .    ds #V .6m
84 .    ds #F 0
85 .    ds #[ \&
86 .    ds #] \&
87 .\}
88 .    \" simple accents for nroff and troff
89 .if n \{\
90 .    ds ' \&
91 .    ds ` \&
92 .    ds ^ \&
93 .    ds , \&
94 .    ds ~ ~
95 .    ds /
96 .\}
97 .if t \{\
98 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 .    \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 .    \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 .    \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 .    ds : e
122 .    ds 8 ss
123 .    ds o a
124 .    ds d- d\h'-1'\(ga
125 .    ds D- D\h'-1'\(hy
126 .    ds th \o'bp'
127 .    ds Th \o'LP'
128 .    ds ae ae
129 .    ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "ELFEDIT 1"
135 .TH ELFEDIT 1 "2011-06-27" "binutils-2.21.1" "GNU Development Tools"
136 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 elfedit \- Update the ELF header of ELF files.
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 elfedit [\fB\-\-input\-mach=\fR\fImachine\fR]
145         [\fB\-\-input\-type=\fR\fItype\fR]
146         [\fB\-\-input\-osabi=\fR\fIosbi\fR]
147         \fB\-\-output\-mach=\fR\fImachine\fR
148         \fB\-\-output\-type=\fR\fItype\fR
149         \fB\-\-output\-osabi=\fR\fIosbi\fR
150         [\fB\-v\fR|\fB\-\-version\fR]
151         [\fB\-h\fR|\fB\-\-help\fR]
152         \fIelffile\fR...
153 .SH "DESCRIPTION"
154 .IX Header "DESCRIPTION"
155 \&\fBelfedit\fR updates the \s-1ELF\s0 header of \s-1ELF\s0 files which have
156 the matching \s-1ELF\s0 machine and file types.  The options control how and
157 which fields in the \s-1ELF\s0 header should be updated.
158 .PP
159 \&\fIelffile\fR... are the \s-1ELF\s0 files to be updated.  32\-bit and
160 64\-bit \s-1ELF\s0 files are supported, as are archives containing \s-1ELF\s0 files.
161 .SH "OPTIONS"
162 .IX Header "OPTIONS"
163 The long and short forms of options, shown here as alternatives, are
164 equivalent. At least one of the \fB\-\-output\-mach\fR,
165 \&\fB\-\-output\-type\fR and \fB\-\-output\-osabi\fR options must be given.
166 .IP "\fB\-\-input\-mach=\fR\fImachine\fR" 4
167 .IX Item "--input-mach=machine"
168 Set the matching input \s-1ELF\s0 machine type to \fImachine\fR.  If
169 \&\fB\-\-input\-mach\fR isn't specified, it will match any \s-1ELF\s0
170 machine types.
171 .Sp
172 The supported \s-1ELF\s0 machine types are, \fIL1OM\fR and \fIx86\-64\fR.
173 .IP "\fB\-\-output\-mach=\fR\fImachine\fR" 4
174 .IX Item "--output-mach=machine"
175 Change the \s-1ELF\s0 machine type in the \s-1ELF\s0 header to \fImachine\fR.  The
176 supported \s-1ELF\s0 machine types are the same as \fB\-\-input\-mach\fR.
177 .IP "\fB\-\-input\-type=\fR\fItype\fR" 4
178 .IX Item "--input-type=type"
179 Set the matching input \s-1ELF\s0 file type to \fItype\fR.  If
180 \&\fB\-\-input\-type\fR isn't specified, it will match any \s-1ELF\s0 file types.
181 .Sp
182 The supported \s-1ELF\s0 file types are, \fIrel\fR, \fIexec\fR and \fIdyn\fR.
183 .IP "\fB\-\-output\-type=\fR\fItype\fR" 4
184 .IX Item "--output-type=type"
185 Change the \s-1ELF\s0 file type in the \s-1ELF\s0 header to \fItype\fR.  The
186 supported \s-1ELF\s0 types are the same as \fB\-\-input\-type\fR.
187 .IP "\fB\-\-input\-osabi=\fR\fIosabi\fR" 4
188 .IX Item "--input-osabi=osabi"
189 Set the matching input \s-1ELF\s0 file \s-1OSABI\s0 to \fIosbi\fR.  If
190 \&\fB\-\-input\-osabi\fR isn't specified, it will match any \s-1ELF\s0 OSABIs.
191 .Sp
192 The supported \s-1ELF\s0 OSABIs are, \fInone\fR, \fI\s-1HPUX\s0\fR, \fINetBSD\fR,
193 \&\fILinux\fR, \fIHurd\fR, \fISolaris\fR, \fI\s-1AIX\s0\fR, \fIIrix\fR,
194 \&\fIFreeBSD\fR, \fI\s-1TRU64\s0\fR, \fIModesto\fR, \fIOpenBSD\fR, \fIOpenVMS\fR,
195 \&\fI\s-1NSK\s0\fR, \fI\s-1AROS\s0\fR and \fIFenixOS\fR.
196 .IP "\fB\-\-output\-osabi=\fR\fIosabi\fR" 4
197 .IX Item "--output-osabi=osabi"
198 Change the \s-1ELF\s0 \s-1OSABI\s0 in the \s-1ELF\s0 header to \fItype\fR.  The
199 supported \s-1ELF\s0 \s-1OSABI\s0 are the same as \fB\-\-input\-osabi\fR.
200 .IP "\fB\-v\fR" 4
201 .IX Item "-v"
202 .PD 0
203 .IP "\fB\-\-version\fR" 4
204 .IX Item "--version"
205 .PD
206 Display the version number of \fBelfedit\fR.
207 .IP "\fB\-h\fR" 4
208 .IX Item "-h"
209 .PD 0
210 .IP "\fB\-\-help\fR" 4
211 .IX Item "--help"
212 .PD
213 Display the command line options understood by \fBelfedit\fR.
214 .IP "\fB@\fR\fIfile\fR" 4
215 .IX Item "@file"
216 Read command-line options from \fIfile\fR.  The options read are
217 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
218 does not exist, or cannot be read, then the option will be treated
219 literally, and not removed.
220 .Sp
221 Options in \fIfile\fR are separated by whitespace.  A whitespace
222 character may be included in an option by surrounding the entire
223 option in either single or double quotes.  Any character (including a
224 backslash) may be included by prefixing the character to be included
225 with a backslash.  The \fIfile\fR may itself contain additional
226 @\fIfile\fR options; any such options will be processed recursively.
227 .SH "SEE ALSO"
228 .IX Header "SEE ALSO"
229 \&\fIreadelf\fR\|(1), and the Info entries for \fIbinutils\fR.
230 .SH "COPYRIGHT"
231 .IX Header "COPYRIGHT"
232 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
233 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010
234 Free Software Foundation, Inc.
235 .PP
236 Permission is granted to copy, distribute and/or modify this document
237 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
238 or any later version published by the Free Software Foundation;
239 with no Invariant Sections, with no Front-Cover Texts, and with no
240 Back-Cover Texts.  A copy of the license is included in the
241 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".