~ubuntu-branches/ubuntu/hoary/binutils/hoary

« back to all changes in this revision

Viewing changes to binutils/doc/strip.1

  • Committer: Bazaar Package Importer
  • Author(s): Martin Pitt
  • Date: 2005-03-18 13:07:52 UTC
  • mfrom: (1.1.2 upstream)
  • Revision ID: james.westby@ubuntu.com-20050318130752-j4i37zgqclj53b94
Tags: 2.15-5ubuntu2
debian/rules: Call pkgstriptranslations if present (the package does not
use debhelper, thus it does not happen automatically).

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
 
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.  | will give a
 
29
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
 
30
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
 
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
 
32
.tr \(*W-|\(bv\*(Tr
 
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
.\" If the F register is turned on, we'll generate index entries on stderr for
 
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
 
53
.\" entries marked with X<> in POD.  Of course, you'll have to process the
 
54
.\" output yourself in some meaningful fashion.
 
55
.if \nF \{\
 
56
.    de IX
 
57
.    tm Index:\\$1\t\\n%\t"\\$2"
 
58
..
 
59
.    nr % 0
 
60
.    rr F
 
61
.\}
 
62
.\"
 
63
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 
64
.\" way too many mistakes in technical documents.
 
65
.hy 0
 
66
.\"
 
67
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 
68
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
 
69
.    \" fudge factors for nroff and troff
 
70
.if n \{\
 
71
.    ds #H 0
 
72
.    ds #V .8m
 
73
.    ds #F .3m
 
74
.    ds #[ \f1
 
75
.    ds #] \fP
 
76
.\}
 
77
.if t \{\
 
78
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
 
79
.    ds #V .6m
 
80
.    ds #F 0
 
81
.    ds #[ \&
 
82
.    ds #] \&
 
83
.\}
 
84
.    \" simple accents for nroff and troff
 
85
.if n \{\
 
86
.    ds ' \&
 
87
.    ds ` \&
 
88
.    ds ^ \&
 
89
.    ds , \&
 
90
.    ds ~ ~
 
91
.    ds /
 
92
.\}
 
93
.if t \{\
 
94
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
 
95
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
 
96
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
 
97
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
 
98
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 
99
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 
100
.\}
 
101
.    \" troff and (daisy-wheel) nroff accents
 
102
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 
103
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 
104
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 
105
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 
106
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 
107
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 
108
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 
109
.ds ae a\h'-(\w'a'u*4/10)'e
 
110
.ds Ae A\h'-(\w'A'u*4/10)'E
 
111
.    \" corrections for vroff
 
112
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 
113
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 
114
.    \" for low resolution devices (crt and lpr)
 
115
.if \n(.H>23 .if \n(.V>19 \
 
116
\{\
 
117
.    ds : e
 
118
.    ds 8 ss
 
119
.    ds o a
 
120
.    ds d- d\h'-1'\(ga
 
121
.    ds D- D\h'-1'\(hy
 
122
.    ds th \o'bp'
 
123
.    ds Th \o'LP'
 
124
.    ds ae ae
 
125
.    ds Ae AE
 
126
.\}
 
127
.rm #[ #] #H #V #F C
 
128
.\" ========================================================================
 
129
.\"
 
130
.IX Title "STRIP 1"
 
131
.TH STRIP 1 "2004-04-09" "binutils-2.14.91" "GNU Development Tools"
 
132
.SH "NAME"
 
133
strip \- Discard symbols from object files.
 
134
.SH "SYNOPSIS"
 
135
.IX Header "SYNOPSIS"
 
136
strip [\fB\-F\fR \fIbfdname\fR |\fB\-\-target=\fR\fIbfdname\fR]
 
137
      [\fB\-I\fR \fIbfdname\fR |\fB\-\-input\-target=\fR\fIbfdname\fR]
 
138
      [\fB\-O\fR \fIbfdname\fR |\fB\-\-output\-target=\fR\fIbfdname\fR]
 
139
      [\fB\-s\fR|\fB\-\-strip\-all\fR]
 
140
      [\fB\-S\fR|\fB\-g\fR|\fB\-d\fR|\fB\-\-strip\-debug\fR]
 
141
      [\fB\-K\fR \fIsymbolname\fR |\fB\-\-keep\-symbol=\fR\fIsymbolname\fR]
 
142
      [\fB\-N\fR \fIsymbolname\fR |\fB\-\-strip\-symbol=\fR\fIsymbolname\fR]
 
143
      [\fB\-w\fR|\fB\-\-wildcard\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\-\-only\-keep\-debug\fR]
 
148
      [\fB\-v\fR |\fB\-\-verbose\fR] [\fB\-V\fR|\fB\-\-version\fR]
 
149
      [\fB\-\-help\fR] [\fB\-\-info\fR]
 
150
      \fIobjfile\fR...
 
151
.SH "DESCRIPTION"
 
152
.IX Header "DESCRIPTION"
 
153
\&\s-1GNU\s0 \fBstrip\fR discards all symbols from object files
 
154
\&\fIobjfile\fR.  The list of object files may include archives.
 
155
At least one object file must be given.
 
156
.PP
 
157
\&\fBstrip\fR modifies the files named in its argument,
 
158
rather than writing modified copies under different names.
 
159
.SH "OPTIONS"
 
160
.IX Header "OPTIONS"
 
161
.IP "\fB\-F\fR \fIbfdname\fR" 4
 
162
.IX Item "-F bfdname"
 
163
.PD 0
 
164
.IP "\fB\-\-target=\fR\fIbfdname\fR" 4
 
165
.IX Item "--target=bfdname"
 
166
.PD
 
167
Treat the original \fIobjfile\fR as a file with the object
 
168
code format \fIbfdname\fR, and rewrite it in the same format.
 
169
.IP "\fB\-\-help\fR" 4
 
170
.IX Item "--help"
 
171
Show a summary of the options to \fBstrip\fR and exit.
 
172
.IP "\fB\-\-info\fR" 4
 
173
.IX Item "--info"
 
174
Display a list showing all architectures and object formats available.
 
175
.IP "\fB\-I\fR \fIbfdname\fR" 4
 
176
.IX Item "-I bfdname"
 
177
.PD 0
 
178
.IP "\fB\-\-input\-target=\fR\fIbfdname\fR" 4
 
179
.IX Item "--input-target=bfdname"
 
180
.PD
 
181
Treat the original \fIobjfile\fR as a file with the object
 
182
code format \fIbfdname\fR.
 
183
.IP "\fB\-O\fR \fIbfdname\fR" 4
 
184
.IX Item "-O bfdname"
 
185
.PD 0
 
186
.IP "\fB\-\-output\-target=\fR\fIbfdname\fR" 4
 
187
.IX Item "--output-target=bfdname"
 
188
.PD
 
189
Replace \fIobjfile\fR with a file in the output format \fIbfdname\fR.
 
190
.IP "\fB\-R\fR \fIsectionname\fR" 4
 
191
.IX Item "-R sectionname"
 
192
.PD 0
 
193
.IP "\fB\-\-remove\-section=\fR\fIsectionname\fR" 4
 
194
.IX Item "--remove-section=sectionname"
 
195
.PD
 
196
Remove any section named \fIsectionname\fR from the output file.  This
 
197
option may be given more than once.  Note that using this option
 
198
inappropriately may make the output file unusable.
 
199
.IP "\fB\-s\fR" 4
 
200
.IX Item "-s"
 
201
.PD 0
 
202
.IP "\fB\-\-strip\-all\fR" 4
 
203
.IX Item "--strip-all"
 
204
.PD
 
205
Remove all symbols.
 
206
.IP "\fB\-g\fR" 4
 
207
.IX Item "-g"
 
208
.PD 0
 
209
.IP "\fB\-S\fR" 4
 
210
.IX Item "-S"
 
211
.IP "\fB\-d\fR" 4
 
212
.IX Item "-d"
 
213
.IP "\fB\-\-strip\-debug\fR" 4
 
214
.IX Item "--strip-debug"
 
215
.PD
 
216
Remove debugging symbols only.
 
217
.IP "\fB\-\-strip\-unneeded\fR" 4
 
218
.IX Item "--strip-unneeded"
 
219
Remove all symbols that are not needed for relocation processing.
 
220
.IP "\fB\-K\fR \fIsymbolname\fR" 4
 
221
.IX Item "-K symbolname"
 
222
.PD 0
 
223
.IP "\fB\-\-keep\-symbol=\fR\fIsymbolname\fR" 4
 
224
.IX Item "--keep-symbol=symbolname"
 
225
.PD
 
226
Keep only symbol \fIsymbolname\fR from the source file.  This option may
 
227
be given more than once.
 
228
.IP "\fB\-N\fR \fIsymbolname\fR" 4
 
229
.IX Item "-N symbolname"
 
230
.PD 0
 
231
.IP "\fB\-\-strip\-symbol=\fR\fIsymbolname\fR" 4
 
232
.IX Item "--strip-symbol=symbolname"
 
233
.PD
 
234
Remove symbol \fIsymbolname\fR from the source file. This option may be
 
235
given more than once, and may be combined with strip options other than
 
236
\&\fB\-K\fR.
 
237
.IP "\fB\-o\fR \fIfile\fR" 4
 
238
.IX Item "-o file"
 
239
Put the stripped output in \fIfile\fR, rather than replacing the
 
240
existing file.  When this argument is used, only one \fIobjfile\fR
 
241
argument may be specified.
 
242
.IP "\fB\-p\fR" 4
 
243
.IX Item "-p"
 
244
.PD 0
 
245
.IP "\fB\-\-preserve\-dates\fR" 4
 
246
.IX Item "--preserve-dates"
 
247
.PD
 
248
Preserve the access and modification dates of the file.
 
249
.IP "\fB\-w\fR" 4
 
250
.IX Item "-w"
 
251
.PD 0
 
252
.IP "\fB\-\-wildcard\fR" 4
 
253
.IX Item "--wildcard"
 
254
.PD
 
255
Permit regular expressions in \fIsymbolname\fRs used in other command
 
256
line options.  The question mark (?), asterisk (*), backslash (\e) and
 
257
square brackets ([]) operators can be used anywhere in the symbol
 
258
name.  If the first character of the symbol name is the exclamation
 
259
point (!) then the sense of the switch is reversed for that symbol.
 
260
For example:
 
261
.Sp
 
262
.Vb 1
 
263
\&          -w -K !foo -K fo*
 
264
.Ve
 
265
.Sp
 
266
would cause strip to only keep symbols that start with the letters
 
267
``fo'', but to discard the symbol ``foo''.
 
268
.IP "\fB\-x\fR" 4
 
269
.IX Item "-x"
 
270
.PD 0
 
271
.IP "\fB\-\-discard\-all\fR" 4
 
272
.IX Item "--discard-all"
 
273
.PD
 
274
Remove non-global symbols.
 
275
.IP "\fB\-X\fR" 4
 
276
.IX Item "-X"
 
277
.PD 0
 
278
.IP "\fB\-\-discard\-locals\fR" 4
 
279
.IX Item "--discard-locals"
 
280
.PD
 
281
Remove compiler-generated local symbols.
 
282
(These usually start with \fBL\fR or \fB.\fR.)
 
283
.IP "\fB\-\-only\-keep\-debug\fR" 4
 
284
.IX Item "--only-keep-debug"
 
285
Strip a file, removing any sections that would be stripped by
 
286
\&\fB\-\-strip\-debug\fR and leaving the debugging sections.
 
287
.Sp
 
288
The intention is that this option will be used in conjunction with
 
289
\&\fB\-\-add\-gnu\-debuglink\fR to create a two part executable.  One a
 
290
stripped binary which will occupy less space in \s-1RAM\s0 and in a
 
291
distribution and the second a debugging information file which is only
 
292
needed if debugging abilities are required.  The suggested procedure
 
293
to create these files is as follows:
 
294
.RS 4
 
295
.IP "1.<Link the executable as normal.  Assuming that is is called>" 4
 
296
.IX Item "1.<Link the executable as normal.  Assuming that is is called>"
 
297
\&\f(CW\*(C`foo\*(C'\fR then...
 
298
.ie n .IP "1.<Run ""objcopy \-\-only\-keep\-debug foo foo.dbg"" to>" 4
 
299
.el .IP "1.<Run \f(CWobjcopy \-\-only\-keep\-debug foo foo.dbg\fR to>" 4
 
300
.IX Item "1.<Run objcopy --only-keep-debug foo foo.dbg to>"
 
301
create a file containing the debugging info.
 
302
.ie n .IP "1.<Run ""objcopy \-\-strip\-debug foo"" to create a>" 4
 
303
.el .IP "1.<Run \f(CWobjcopy \-\-strip\-debug foo\fR to create a>" 4
 
304
.IX Item "1.<Run objcopy --strip-debug foo to create a>"
 
305
stripped executable.
 
306
.ie n .IP "1.<Run ""objcopy \-\-add\-gnu\-debuglink=foo.dbg foo"">" 4
 
307
.el .IP "1.<Run \f(CWobjcopy \-\-add\-gnu\-debuglink=foo.dbg foo\fR>" 4
 
308
.IX Item "1.<Run objcopy --add-gnu-debuglink=foo.dbg foo>"
 
309
to add a link to the debugging info into the stripped executable.
 
310
.RE
 
311
.RS 4
 
312
.Sp
 
313
Note \- the choice of \f(CW\*(C`.dbg\*(C'\fR as an extension for the debug info
 
314
file is arbitrary.  Also the \f(CW\*(C`\-\-only\-keep\-debug\*(C'\fR step is
 
315
optional.  You could instead do this:
 
316
.IP "1.<Link the executable as normal.>" 4
 
317
.IX Item "1.<Link the executable as normal.>"
 
318
.PD 0
 
319
.ie n .IP "1.<Copy ""foo""\fR to  \f(CW""foo.full"">" 4
 
320
.el .IP "1.<Copy \f(CWfoo\fR to  \f(CWfoo.full\fR>" 4
 
321
.IX Item "1.<Copy foo to  foo.full>"
 
322
.ie n .IP "1.<Run ""strip \-\-strip\-debug foo"">" 4
 
323
.el .IP "1.<Run \f(CWstrip \-\-strip\-debug foo\fR>" 4
 
324
.IX Item "1.<Run strip --strip-debug foo>"
 
325
.ie n .IP "1.<Run ""objcopy \-\-add\-gnu\-debuglink=foo.full foo"">" 4
 
326
.el .IP "1.<Run \f(CWobjcopy \-\-add\-gnu\-debuglink=foo.full foo\fR>" 4
 
327
.IX Item "1.<Run objcopy --add-gnu-debuglink=foo.full foo>"
 
328
.RE
 
329
.RS 4
 
330
.PD
 
331
.Sp
 
332
ie the file pointed to by the \fB\-\-add\-gnu\-debuglink\fR can be the
 
333
full executable.  It does not have to be a file created by the
 
334
\&\fB\-\-only\-keep\-debug\fR switch.
 
335
.RE
 
336
.IP "\fB\-V\fR" 4
 
337
.IX Item "-V"
 
338
.PD 0
 
339
.IP "\fB\-\-version\fR" 4
 
340
.IX Item "--version"
 
341
.PD
 
342
Show the version number for \fBstrip\fR.
 
343
.IP "\fB\-v\fR" 4
 
344
.IX Item "-v"
 
345
.PD 0
 
346
.IP "\fB\-\-verbose\fR" 4
 
347
.IX Item "--verbose"
 
348
.PD
 
349
Verbose output: list all object files modified.  In the case of
 
350
archives, \fBstrip \-v\fR lists all members of the archive.
 
351
.SH "SEE ALSO"
 
352
.IX Header "SEE ALSO"
 
353
the Info entries for \fIbinutils\fR.
 
354
.SH "COPYRIGHT"
 
355
.IX Header "COPYRIGHT"
 
356
Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000,
 
357
2001, 2002, 2003 Free Software Foundation, Inc.
 
358
.PP
 
359
Permission is granted to copy, distribute and/or modify this document
 
360
under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
 
361
or any later version published by the Free Software Foundation;
 
362
with no Invariant Sections, with no Front-Cover Texts, and with no
 
363
Back-Cover Texts.  A copy of the license is included in the
 
364
section entitled ``\s-1GNU\s0 Free Documentation License''.