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