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