Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / binutils / binutils / doc / strip.1
1 .\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13
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
25 .fi
26 ..
27 .\" Set up some character translations and predefined strings.  \*(-- will
28 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
29 .\" double quote, and \*(R" will give a right double quote.  | will give a
30 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
31 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
32 .\" expand to `' in nroff, nothing in troff, for use with C<>.
33 .tr \(*W-|\(bv\*(Tr
34 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
35 .ie n \{\
36 .    ds -- \(*W-
37 .    ds PI pi
38 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
39 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
40 .    ds L" ""
41 .    ds R" ""
42 .    ds C` ""
43 .    ds C' ""
44 'br\}
45 .el\{\
46 .    ds -- \|\(em\|
47 .    ds PI \(*p
48 .    ds L" ``
49 .    ds R" ''
50 'br\}
51 .\"
52 .\" If the F register is turned on, we'll generate index entries on stderr for
53 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
54 .\" entries marked with X<> in POD.  Of course, you'll have to process the
55 .\" output yourself in some meaningful fashion.
56 .if \nF \{\
57 .    de IX
58 .    tm Index:\\$1\t\\n%\t"\\$2"
59 ..
60 .    nr % 0
61 .    rr F
62 .\}
63 .\"
64 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
65 .\" way too many mistakes in technical documents.
66 .hy 0
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "STRIP 1"
132 .TH STRIP 1 "2002-05-14" "binutils-2.12.1" "GNU Development Tools"
133 .UC
134 .SH "NAME"
135 strip \- Discard symbols from object files.
136 .SH "SYNOPSIS"
137 .IX Header "SYNOPSIS"
138 strip [\fB\-F\fR \fIbfdname\fR |\fB\-\-target=\fR\fIbfdname\fR ]
139       [\fB\-I\fR \fIbfdname\fR |\fB\-\-input\-target=\fR\fIbfdname\fR ]
140       [\fB\-O\fR \fIbfdname\fR |\fB\-\-output\-target=\fR\fIbfdname\fR ]
141       [\fB\-s\fR|\fB\-\-strip\-all\fR] [\fB\-S\fR|\fB\-g\fR|\fB\-d\fR|\fB\-\-strip\-debug\fR]
142       [\fB\-K\fR \fIsymbolname\fR |\fB\-\-keep\-symbol=\fR\fIsymbolname\fR ]
143       [\fB\-N\fR \fIsymbolname\fR |\fB\-\-strip\-symbol=\fR\fIsymbolname\fR ]
144       [\fB\-x\fR|\fB\-\-discard\-all\fR ] [\fB\-X\fR |\fB\-\-discard\-locals\fR]
145       [\fB\-R\fR \fIsectionname\fR |\fB\-\-remove\-section=\fR\fIsectionname\fR ]
146       [\fB\-o\fR \fIfile\fR ] [\fB\-p\fR|\fB\-\-preserve\-dates\fR]
147       [\fB\-v\fR |\fB\-\-verbose\fR]  [\fB\-V\fR|\fB\-\-version\fR] [\fB\-\-help\fR]
148       \fIobjfile\fR...
149 .SH "DESCRIPTION"
150 .IX Header "DESCRIPTION"
151 \&\s-1GNU\s0 \fBstrip\fR discards all symbols from object files
152 \&\fIobjfile\fR.  The list of object files may include archives.
153 At least one object file must be given.
154 .PP
155 \&\fBstrip\fR modifies the files named in its argument,
156 rather than writing modified copies under different names.
157 .SH "OPTIONS"
158 .IX Header "OPTIONS"
159 .IP "\fB\-F\fR \fIbfdname\fR" 4
160 .IX Item "-F bfdname"
161 .PD 0
162 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4
163 .IX Item "--target=bfdname"
164 .PD
165 Treat the original \fIobjfile\fR as a file with the object
166 code format \fIbfdname\fR, and rewrite it in the same format.
167 .IP "\fB\-\-help\fR" 4
168 .IX Item "--help"
169 Show a summary of the options to \fBstrip\fR and exit.
170 .IP "\fB\-I\fR \fIbfdname\fR\fB \fR" 4
171 .IX Item "-I bfdname    "
172 .PD 0
173 .IP "\fB\-\-input\-target=\fR\fIbfdname\fR" 4
174 .IX Item "--input-target=bfdname"
175 .PD
176 Treat the original \fIobjfile\fR as a file with the object
177 code format \fIbfdname\fR.
178 .IP "\fB\-O\fR \fIbfdname\fR" 4
179 .IX Item "-O bfdname"
180 .PD 0
181 .IP "\fB\-\-output\-target=\fR\fIbfdname\fR" 4
182 .IX Item "--output-target=bfdname"
183 .PD
184 Replace \fIobjfile\fR with a file in the output format \fIbfdname\fR.
185 .IP "\fB\-R\fR \fIsectionname\fR" 4
186 .IX Item "-R sectionname"
187 .PD 0
188 .IP "\fB\-\-remove\-section=\fR\fIsectionname\fR" 4
189 .IX Item "--remove-section=sectionname"
190 .PD
191 Remove any section named \fIsectionname\fR from the output file.  This
192 option may be given more than once.  Note that using this option
193 inappropriately may make the output file unusable.
194 .IP "\fB\-s\fR" 4
195 .IX Item "-s"
196 .PD 0
197 .IP "\fB\-\-strip\-all\fR" 4
198 .IX Item "--strip-all"
199 .PD
200 Remove all symbols.
201 .IP "\fB\-g\fR" 4
202 .IX Item "-g"
203 .PD 0
204 .IP "\fB\-S\fR" 4
205 .IX Item "-S"
206 .IP "\fB\-d\fR" 4
207 .IX Item "-d"
208 .IP "\fB\-\-strip\-debug\fR" 4
209 .IX Item "--strip-debug"
210 .PD
211 Remove debugging symbols only.
212 .IP "\fB\-\-strip\-unneeded\fR" 4
213 .IX Item "--strip-unneeded"
214 Remove all symbols that are not needed for relocation processing.
215 .IP "\fB\-K\fR \fIsymbolname\fR" 4
216 .IX Item "-K symbolname"
217 .PD 0
218 .IP "\fB\-\-keep\-symbol=\fR\fIsymbolname\fR" 4
219 .IX Item "--keep-symbol=symbolname"
220 .PD
221 Keep only symbol \fIsymbolname\fR from the source file.  This option may
222 be given more than once.
223 .IP "\fB\-N\fR \fIsymbolname\fR" 4
224 .IX Item "-N symbolname"
225 .PD 0
226 .IP "\fB\-\-strip\-symbol=\fR\fIsymbolname\fR" 4
227 .IX Item "--strip-symbol=symbolname"
228 .PD
229 Remove symbol \fIsymbolname\fR from the source file. This option may be
230 given more than once, and may be combined with strip options other than
231 \&\fB\-K\fR.
232 .IP "\fB\-o\fR \fIfile\fR" 4
233 .IX Item "-o file"
234 Put the stripped output in \fIfile\fR, rather than replacing the
235 existing file.  When this argument is used, only one \fIobjfile\fR
236 argument may be specified.
237 .IP "\fB\-p\fR" 4
238 .IX Item "-p"
239 .PD 0
240 .IP "\fB\-\-preserve\-dates\fR" 4
241 .IX Item "--preserve-dates"
242 .PD
243 Preserve the access and modification dates of the file.
244 .IP "\fB\-x\fR" 4
245 .IX Item "-x"
246 .PD 0
247 .IP "\fB\-\-discard\-all\fR" 4
248 .IX Item "--discard-all"
249 .PD
250 Remove non-global symbols.
251 .IP "\fB\-X\fR" 4
252 .IX Item "-X"
253 .PD 0
254 .IP "\fB\-\-discard\-locals\fR" 4
255 .IX Item "--discard-locals"
256 .PD
257 Remove compiler-generated local symbols.
258 (These usually start with \fBL\fR or \fB.\fR.)
259 .IP "\fB\-V\fR" 4
260 .IX Item "-V"
261 .PD 0
262 .IP "\fB\-\-version\fR" 4
263 .IX Item "--version"
264 .PD
265 Show the version number for \fBstrip\fR.
266 .IP "\fB\-v\fR" 4
267 .IX Item "-v"
268 .PD 0
269 .IP "\fB\-\-verbose\fR" 4
270 .IX Item "--verbose"
271 .PD
272 Verbose output: list all object files modified.  In the case of
273 archives, \fBstrip \-v\fR lists all members of the archive.
274 .SH "SEE ALSO"
275 .IX Header "SEE ALSO"
276 the Info entries for \fIbinutils\fR.
277 .SH "COPYRIGHT"
278 .IX Header "COPYRIGHT"
279 Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
280 .PP
281 Permission is granted to copy, distribute and/or modify this document
282 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
283 or any later version published by the Free Software Foundation;
284 with no Invariant Sections, with no Front-Cover Texts, and with no
285 Back-Cover Texts.  A copy of the license is included in the
286 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".