contrib/binutils-2.27/binutils/doc/strip.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 "STRIP 1"
 136 .TH STRIP 1 "2016-08-03" "binutils-2.27" "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 strip \- Discard symbols from object files.
 143 .SH "SYNOPSIS"
 144 .IX Header "SYNOPSIS"
 145 strip [\fB\-F\fR \fIbfdname\fR |\fB\-\-target=\fR\fIbfdname\fR]
 146       [\fB\-I\fR \fIbfdname\fR |\fB\-\-input\-target=\fR\fIbfdname\fR]
 147       [\fB\-O\fR \fIbfdname\fR |\fB\-\-output\-target=\fR\fIbfdname\fR]
 148       [\fB\-s\fR|\fB\-\-strip\-all\fR]
 149       [\fB\-S\fR|\fB\-g\fR|\fB\-d\fR|\fB\-\-strip\-debug\fR]
 150       [\fB\-\-strip\-dwo\fR]
 151       [\fB\-K\fR \fIsymbolname\fR |\fB\-\-keep\-symbol=\fR\fIsymbolname\fR]
 152       [\fB\-N\fR \fIsymbolname\fR |\fB\-\-strip\-symbol=\fR\fIsymbolname\fR]
 153       [\fB\-w\fR|\fB\-\-wildcard\fR]
 154       [\fB\-x\fR|\fB\-\-discard\-all\fR] [\fB\-X\fR |\fB\-\-discard\-locals\fR]
 155       [\fB\-R\fR \fIsectionname\fR |\fB\-\-remove\-section=\fR\fIsectionname\fR]
 156       [\fB\-o\fR \fIfile\fR] [\fB\-p\fR|\fB\-\-preserve\-dates\fR]
 157       [\fB\-D\fR|\fB\-\-enable\-deterministic\-archives\fR]
 158       [\fB\-U\fR|\fB\-\-disable\-deterministic\-archives\fR]
 159       [\fB\-\-keep\-file\-symbols\fR]
 160       [\fB\-\-only\-keep\-debug\fR]
 161       [\fB\-v\fR |\fB\-\-verbose\fR] [\fB\-V\fR|\fB\-\-version\fR]
 162       [\fB\-\-help\fR] [\fB\-\-info\fR]
 163       \fIobjfile\fR...
 164 .SH "DESCRIPTION"
 165 .IX Header "DESCRIPTION"
 166 \&\s-1GNU \s0\fBstrip\fR discards all symbols from object files
 167 \&\fIobjfile\fR.  The list of object files may include archives.
 168 At least one object file must be given.
 169 .PP
 170 \&\fBstrip\fR modifies the files named in its argument,
 171 rather than writing modified copies under different names.
 172 .SH "OPTIONS"
 173 .IX Header "OPTIONS"
 174 .IP "\fB\-F\fR \fIbfdname\fR" 4
 175 .IX Item "-F bfdname"
 176 .PD 0
 177 .IP "\fB\-\-target=\fR\fIbfdname\fR" 4
 178 .IX Item "--target=bfdname"
 179 .PD
 180 Treat the original \fIobjfile\fR as a file with the object
 181 code format \fIbfdname\fR, and rewrite it in the same format.
 182 .IP "\fB\-\-help\fR" 4
 183 .IX Item "--help"
 184 Show a summary of the options to \fBstrip\fR and exit.
 185 .IP "\fB\-\-info\fR" 4
 186 .IX Item "--info"
 187 Display a list showing all architectures and object formats available.
 188 .IP "\fB\-I\fR \fIbfdname\fR" 4
 189 .IX Item "-I bfdname"
 190 .PD 0
 191 .IP "\fB\-\-input\-target=\fR\fIbfdname\fR" 4
 192 .IX Item "--input-target=bfdname"
 193 .PD
 194 Treat the original \fIobjfile\fR as a file with the object
 195 code format \fIbfdname\fR.
 196 .IP "\fB\-O\fR \fIbfdname\fR" 4
 197 .IX Item "-O bfdname"
 198 .PD 0
 199 .IP "\fB\-\-output\-target=\fR\fIbfdname\fR" 4
 200 .IX Item "--output-target=bfdname"
 201 .PD
 202 Replace \fIobjfile\fR with a file in the output format \fIbfdname\fR.
 203 .IP "\fB\-R\fR \fIsectionname\fR" 4
 204 .IX Item "-R sectionname"
 205 .PD 0
 206 .IP "\fB\-\-remove\-section=\fR\fIsectionname\fR" 4
 207 .IX Item "--remove-section=sectionname"
 208 .PD
 209 Remove any section named \fIsectionname\fR from the output file, in
 210 addition to whatever sections would otherwise be removed.  This
 211 option may be given more than once.  Note that using this option
 212 inappropriately may make the output file unusable.  The wildcard
 213 character \fB*\fR may be given at the end of \fIsectionname\fR.  If
 214 so, then any section starting with \fIsectionname\fR will be removed.
 215 .IP "\fB\-s\fR" 4
 216 .IX Item "-s"
 217 .PD 0
 218 .IP "\fB\-\-strip\-all\fR" 4
 219 .IX Item "--strip-all"
 220 .PD
 221 Remove all symbols.
 222 .IP "\fB\-g\fR" 4
 223 .IX Item "-g"
 224 .PD 0
 225 .IP "\fB\-S\fR" 4
 226 .IX Item "-S"
 227 .IP "\fB\-d\fR" 4
 228 .IX Item "-d"
 229 .IP "\fB\-\-strip\-debug\fR" 4
 230 .IX Item "--strip-debug"
 231 .PD
 232 Remove debugging symbols only.
 233 .IP "\fB\-\-strip\-dwo\fR" 4
 234 .IX Item "--strip-dwo"
 235 Remove the contents of all \s-1DWARF \s0.dwo sections, leaving the
 236 remaining debugging sections and all symbols intact.
 237 See the description of this option in the \fBobjcopy\fR section
 238 for more information.
 239 .IP "\fB\-\-strip\-unneeded\fR" 4
 240 .IX Item "--strip-unneeded"
 241 Remove all symbols that are not needed for relocation processing.
 242 .IP "\fB\-K\fR \fIsymbolname\fR" 4
 243 .IX Item "-K symbolname"
 244 .PD 0
 245 .IP "\fB\-\-keep\-symbol=\fR\fIsymbolname\fR" 4
 246 .IX Item "--keep-symbol=symbolname"
 247 .PD
 248 When stripping symbols, keep symbol \fIsymbolname\fR even if it would
 249 normally be stripped.  This option may be given more than once.
 250 .IP "\fB\-N\fR \fIsymbolname\fR" 4
 251 .IX Item "-N symbolname"
 252 .PD 0
 253 .IP "\fB\-\-strip\-symbol=\fR\fIsymbolname\fR" 4
 254 .IX Item "--strip-symbol=symbolname"
 255 .PD
 256 Remove symbol \fIsymbolname\fR from the source file. This option may be
 257 given more than once, and may be combined with strip options other than
 258 \&\fB\-K\fR.
 259 .IP "\fB\-o\fR \fIfile\fR" 4
 260 .IX Item "-o file"
 261 Put the stripped output in \fIfile\fR, rather than replacing the
 262 existing file.  When this argument is used, only one \fIobjfile\fR
 263 argument may be specified.
 264 .IP "\fB\-p\fR" 4
 265 .IX Item "-p"
 266 .PD 0
 267 .IP "\fB\-\-preserve\-dates\fR" 4
 268 .IX Item "--preserve-dates"
 269 .PD
 270 Preserve the access and modification dates of the file.
 271 .IP "\fB\-D\fR" 4
 272 .IX Item "-D"
 273 .PD 0
 274 .IP "\fB\-\-enable\-deterministic\-archives\fR" 4
 275 .IX Item "--enable-deterministic-archives"
 276 .PD
 277 Operate in \fIdeterministic\fR mode.  When copying archive members
 278 and writing the archive index, use zero for UIDs, GIDs, timestamps,
 279 and use consistent file modes for all files.
 280 .Sp
 281 If \fIbinutils\fR was configured with
 282 \&\fB\-\-enable\-deterministic\-archives\fR, then this mode is on by default.
 283 It can be disabled with the \fB\-U\fR option, below.
 284 .IP "\fB\-U\fR" 4
 285 .IX Item "-U"
 286 .PD 0
 287 .IP "\fB\-\-disable\-deterministic\-archives\fR" 4
 288 .IX Item "--disable-deterministic-archives"
 289 .PD
 290 Do \fInot\fR operate in \fIdeterministic\fR mode.  This is the
 291 inverse of the \fB\-D\fR option, above: when copying archive members
 292 and writing the archive index, use their actual \s-1UID, GID,\s0 timestamp,
 293 and file mode values.
 294 .Sp
 295 This is the default unless \fIbinutils\fR was configured with
 296 \&\fB\-\-enable\-deterministic\-archives\fR.
 297 .IP "\fB\-w\fR" 4
 298 .IX Item "-w"
 299 .PD 0
 300 .IP "\fB\-\-wildcard\fR" 4
 301 .IX Item "--wildcard"
 302 .PD
 303 Permit regular expressions in \fIsymbolname\fRs used in other command
 304 line options.  The question mark (?), asterisk (*), backslash (\e) and
 305 square brackets ([]) operators can be used anywhere in the symbol
 306 name.  If the first character of the symbol name is the exclamation
 307 point (!) then the sense of the switch is reversed for that symbol.
 308 For example:
 309 .Sp
 310 .Vb 1
 311 \&          \-w \-K !foo \-K fo*
 312 .Ve
 313 .Sp
 314 would cause strip to only keep symbols that start with the letters
 315 \&\*(L"fo\*(R", but to discard the symbol \*(L"foo\*(R".
 316 .IP "\fB\-x\fR" 4
 317 .IX Item "-x"
 318 .PD 0
 319 .IP "\fB\-\-discard\-all\fR" 4
 320 .IX Item "--discard-all"
 321 .PD
 322 Remove non-global symbols.
 323 .IP "\fB\-X\fR" 4
 324 .IX Item "-X"
 325 .PD 0
 326 .IP "\fB\-\-discard\-locals\fR" 4
 327 .IX Item "--discard-locals"
 328 .PD
 329 Remove compiler-generated local symbols.
 330 (These usually start with \fBL\fR or \fB.\fR.)
 331 .IP "\fB\-\-keep\-file\-symbols\fR" 4
 332 .IX Item "--keep-file-symbols"
 333 When stripping a file, perhaps with \fB\-\-strip\-debug\fR or
 334 \&\fB\-\-strip\-unneeded\fR, retain any symbols specifying source file names,
 335 which would otherwise get stripped.
 336 .IP "\fB\-\-only\-keep\-debug\fR" 4
 337 .IX Item "--only-keep-debug"
 338 Strip a file, emptying the contents of any sections that would not be
 339 stripped by \fB\-\-strip\-debug\fR and leaving the debugging sections
 340 intact.  In \s-1ELF\s0 files, this preserves all the note sections in the
 341 output as well.
 342 .Sp
 343 Note \- the section headers of the stripped sections are preserved,
 344 including their sizes, but the contents of the section are discarded.
 345 The section headers are preserved so that other tools can match up the
 346 debuginfo file with the real executable, even if that executable has
 347 been relocated to a different address space.
 348 .Sp
 349 The intention is that this option will be used in conjunction with
 350 \&\fB\-\-add\-gnu\-debuglink\fR to create a two part executable.  One a
 351 stripped binary which will occupy less space in \s-1RAM\s0 and in a
 352 distribution and the second a debugging information file which is only
 353 needed if debugging abilities are required.  The suggested procedure
 354 to create these files is as follows:
 355 .RS 4
 356 .IP "1.<Link the executable as normal.  Assuming that is is called>" 4
 357 .IX Item "1.<Link the executable as normal. Assuming that is is called>"
 358 \&\f(CW\*(C`foo\*(C'\fR then...
 359 .ie n .IP "1.<Run ""objcopy \-\-only\-keep\-debug foo foo.dbg"" to>" 4
 360 .el .IP "1.<Run \f(CWobjcopy \-\-only\-keep\-debug foo foo.dbg\fR to>" 4
 361 .IX Item "1.<Run objcopy --only-keep-debug foo foo.dbg to>"
 362 create a file containing the debugging info.
 363 .ie n .IP "1.<Run ""objcopy \-\-strip\-debug foo"" to create a>" 4
 364 .el .IP "1.<Run \f(CWobjcopy \-\-strip\-debug foo\fR to create a>" 4
 365 .IX Item "1.<Run objcopy --strip-debug foo to create a>"
 366 stripped executable.
 367 .ie n .IP "1.<Run ""objcopy \-\-add\-gnu\-debuglink=foo.dbg foo"">" 4
 368 .el .IP "1.<Run \f(CWobjcopy \-\-add\-gnu\-debuglink=foo.dbg foo\fR>" 4
 369 .IX Item "1.<Run objcopy --add-gnu-debuglink=foo.dbg foo>"
 370 to add a link to the debugging info into the stripped executable.
 371 .RE
 372 .RS 4
 373 .Sp
 374 Note\-\-\-the choice of \f(CW\*(C`.dbg\*(C'\fR as an extension for the debug info
 375 file is arbitrary.  Also the \f(CW\*(C`\-\-only\-keep\-debug\*(C'\fR step is
 376 optional.  You could instead do this:
 377 .IP "1.<Link the executable as normal.>" 4
 378 .IX Item "1.<Link the executable as normal.>"
 379 .PD 0
 380 .ie n .IP "1.<Copy ""foo"" to ""foo.full"">" 4
 381 .el .IP "1.<Copy \f(CWfoo\fR to \f(CWfoo.full\fR>" 4
 382 .IX Item "1.<Copy foo to foo.full>"
 383 .ie n .IP "1.<Run ""strip \-\-strip\-debug foo"">" 4
 384 .el .IP "1.<Run \f(CWstrip \-\-strip\-debug foo\fR>" 4
 385 .IX Item "1.<Run strip --strip-debug foo>"
 386 .ie n .IP "1.<Run ""objcopy \-\-add\-gnu\-debuglink=foo.full foo"">" 4
 387 .el .IP "1.<Run \f(CWobjcopy \-\-add\-gnu\-debuglink=foo.full foo\fR>" 4
 388 .IX Item "1.<Run objcopy --add-gnu-debuglink=foo.full foo>"
 389 .RE
 390 .RS 4
 391 .PD
 392 .Sp
 393 i.e., the file pointed to by the \fB\-\-add\-gnu\-debuglink\fR can be the
 394 full executable.  It does not have to be a file created by the
 395 \&\fB\-\-only\-keep\-debug\fR switch.
 396 .Sp
 397 Note\-\-\-this switch is only intended for use on fully linked files.  It
 398 does not make sense to use it on object files where the debugging
 399 information may be incomplete.  Besides the gnu_debuglink feature
 400 currently only supports the presence of one filename containing
 401 debugging information, not multiple filenames on a one-per-object-file
 402 basis.
 403 .RE
 404 .IP "\fB\-V\fR" 4
 405 .IX Item "-V"
 406 .PD 0
 407 .IP "\fB\-\-version\fR" 4
 408 .IX Item "--version"
 409 .PD
 410 Show the version number for \fBstrip\fR.
 411 .IP "\fB\-v\fR" 4
 412 .IX Item "-v"
 413 .PD 0
 414 .IP "\fB\-\-verbose\fR" 4
 415 .IX Item "--verbose"
 416 .PD
 417 Verbose output: list all object files modified.  In the case of
 418 archives, \fBstrip \-v\fR lists all members of the archive.
 419 .IP "\fB@\fR\fIfile\fR" 4
 420 .IX Item "@file"
 421 Read command-line options from \fIfile\fR.  The options read are
 422 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
 423 does not exist, or cannot be read, then the option will be treated
 424 literally, and not removed.
 425 .Sp
 426 Options in \fIfile\fR are separated by whitespace.  A whitespace
 427 character may be included in an option by surrounding the entire
 428 option in either single or double quotes.  Any character (including a
 429 backslash) may be included by prefixing the character to be included
 430 with a backslash.  The \fIfile\fR may itself contain additional
 431 @\fIfile\fR options; any such options will be processed recursively.
 432 .SH "SEE ALSO"
 433 .IX Header "SEE ALSO"
 434 the Info entries for \fIbinutils\fR.
 435 .SH "COPYRIGHT"
 436 .IX Header "COPYRIGHT"
 437 Copyright (c) 1991\-2016 Free Software Foundation, Inc.
 438 .PP
 439 Permission is granted to copy, distribute and/or modify this document
 440 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
 441 or any later version published by the Free Software Foundation;
 442 with no Invariant Sections, with no Front-Cover Texts, and with no
 443 Back-Cover Texts.  A copy of the license is included in the
 444 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".