Initial bulk commit for "Git on MSys"

[msysgit/historical-msysgit.git] / mingw / man / man1 / strip.1

.\" Automatically generated by Pod::Man version 1.15
.\" Thu Jan 19 19:58:48 2006
.\"
.\" Standard preamble:
.\" ======================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R

.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used
.\" to do unbreakable dashes and therefore won't be available.  \*(C` and
.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr
.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
.\" index entries marked with X<> in POD.  Of course, you'll have to process
.\" the output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it
.\" makes way too many mistakes in technical documents.
.hy 0
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.bd B 3
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ======================================================================
.\"
.IX Title "STRIP 1"
.TH STRIP 1 "binutils-2.16.91" "2006-01-19" "GNU Development Tools"
.UC
.SH "NAME"
strip \- Discard symbols from object files.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
strip [\fB\-F\fR \fIbfdname\fR |\fB\*(--target=\fR\fIbfdname\fR]
      [\fB\-I\fR \fIbfdname\fR |\fB\*(--input-target=\fR\fIbfdname\fR]
      [\fB\-O\fR \fIbfdname\fR |\fB\*(--output-target=\fR\fIbfdname\fR]
      [\fB\-s\fR|\fB\*(--strip-all\fR]
      [\fB\-S\fR|\fB\-g\fR|\fB\-d\fR|\fB\*(--strip-debug\fR]
      [\fB\-K\fR \fIsymbolname\fR |\fB\*(--keep-symbol=\fR\fIsymbolname\fR]
      [\fB\-N\fR \fIsymbolname\fR |\fB\*(--strip-symbol=\fR\fIsymbolname\fR]
      [\fB\-w\fR|\fB\*(--wildcard\fR]
      [\fB\-x\fR|\fB\*(--discard-all\fR] [\fB\-X\fR |\fB\*(--discard-locals\fR]
      [\fB\-R\fR \fIsectionname\fR |\fB\*(--remove-section=\fR\fIsectionname\fR]
      [\fB\-o\fR \fIfile\fR] [\fB\-p\fR|\fB\*(--preserve-dates\fR]
      [\fB\*(--keep-file-symbols\fR]
      [\fB\*(--only-keep-debug\fR]
      [\fB\-v\fR |\fB\*(--verbose\fR] [\fB\-V\fR|\fB\*(--version\fR]
      [\fB\*(--help\fR] [\fB\*(--info\fR]
      \fIobjfile\fR...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\s-1GNU\s0 \fBstrip\fR discards all symbols from object files
\&\fIobjfile\fR.  The list of object files may include archives.
At least one object file must be given.
.PP
\&\fBstrip\fR modifies the files named in its argument,
rather than writing modified copies under different names.
.SH "OPTIONS"
.IX Header "OPTIONS"
.Ip "\fB\-F\fR \fIbfdname\fR" 4
.IX Item "-F bfdname"
.PD 0
.Ip "\fB\*(--target=\fR\fIbfdname\fR" 4
.IX Item "target=bfdname"
.PD
Treat the original \fIobjfile\fR as a file with the object
code format \fIbfdname\fR, and rewrite it in the same format.
.Ip "\fB\*(--help\fR" 4
.IX Item "help"
Show a summary of the options to \fBstrip\fR and exit.
.Ip "\fB\*(--info\fR" 4
.IX Item "info"
Display a list showing all architectures and object formats available.
.Ip "\fB\-I\fR \fIbfdname\fR" 4
.IX Item "-I bfdname"
.PD 0
.Ip "\fB\*(--input-target=\fR\fIbfdname\fR" 4
.IX Item "input-target=bfdname"
.PD
Treat the original \fIobjfile\fR as a file with the object
code format \fIbfdname\fR.
.Ip "\fB\-O\fR \fIbfdname\fR" 4
.IX Item "-O bfdname"
.PD 0
.Ip "\fB\*(--output-target=\fR\fIbfdname\fR" 4
.IX Item "output-target=bfdname"
.PD
Replace \fIobjfile\fR with a file in the output format \fIbfdname\fR.
.Ip "\fB\-R\fR \fIsectionname\fR" 4
.IX Item "-R sectionname"
.PD 0
.Ip "\fB\*(--remove-section=\fR\fIsectionname\fR" 4
.IX Item "remove-section=sectionname"
.PD
Remove any section named \fIsectionname\fR from the output file.  This
option may be given more than once.  Note that using this option
inappropriately may make the output file unusable.
.Ip "\fB\-s\fR" 4
.IX Item "-s"
.PD 0
.Ip "\fB\*(--strip-all\fR" 4
.IX Item "strip-all"
.PD
Remove all symbols.
.Ip "\fB\-g\fR" 4
.IX Item "-g"
.PD 0
.Ip "\fB\-S\fR" 4
.IX Item "-S"
.Ip "\fB\-d\fR" 4
.IX Item "-d"
.Ip "\fB\*(--strip-debug\fR" 4
.IX Item "strip-debug"
.PD
Remove debugging symbols only.
.Ip "\fB\*(--strip-unneeded\fR" 4
.IX Item "strip-unneeded"
Remove all symbols that are not needed for relocation processing.
.Ip "\fB\-K\fR \fIsymbolname\fR" 4
.IX Item "-K symbolname"
.PD 0
.Ip "\fB\*(--keep-symbol=\fR\fIsymbolname\fR" 4
.IX Item "keep-symbol=symbolname"
.PD
When stripping symbols, keep symbol \fIsymbolname\fR even if it would
normally be stripped.  This option may be given more than once.
.Ip "\fB\-N\fR \fIsymbolname\fR" 4
.IX Item "-N symbolname"
.PD 0
.Ip "\fB\*(--strip-symbol=\fR\fIsymbolname\fR" 4
.IX Item "strip-symbol=symbolname"
.PD
Remove symbol \fIsymbolname\fR from the source file. This option may be
given more than once, and may be combined with strip options other than
\&\fB\-K\fR.
.Ip "\fB\-o\fR \fIfile\fR" 4
.IX Item "-o file"
Put the stripped output in \fIfile\fR, rather than replacing the
existing file.  When this argument is used, only one \fIobjfile\fR
argument may be specified.
.Ip "\fB\-p\fR" 4
.IX Item "-p"
.PD 0
.Ip "\fB\*(--preserve-dates\fR" 4
.IX Item "preserve-dates"
.PD
Preserve the access and modification dates of the file.
.Ip "\fB\-w\fR" 4
.IX Item "-w"
.PD 0
.Ip "\fB\*(--wildcard\fR" 4
.IX Item "wildcard"
.PD
Permit regular expressions in \fIsymbolname\fRs used in other command
line options.  The question mark (?), asterisk (*), backslash (\e) and
square brackets ([]) operators can be used anywhere in the symbol
name.  If the first character of the symbol name is the exclamation
point (!) then the sense of the switch is reversed for that symbol.
For example:
.Sp
.Vb 1
\&          -w -K !foo -K fo*
.Ve
would cause strip to only keep symbols that start with the letters
\&\*(L"fo\*(R", but to discard the symbol \*(L"foo\*(R".
.Ip "\fB\-x\fR" 4
.IX Item "-x"
.PD 0
.Ip "\fB\*(--discard-all\fR" 4
.IX Item "discard-all"
.PD
Remove non-global symbols.
.Ip "\fB\-X\fR" 4
.IX Item "-X"
.PD 0
.Ip "\fB\*(--discard-locals\fR" 4
.IX Item "discard-locals"
.PD
Remove compiler-generated local symbols.
(These usually start with \fBL\fR or \fB.\fR.)
.Ip "\fB\*(--keep-file-symbols\fR" 4
.IX Item "keep-file-symbols"
When stripping a file, perhaps with \fB\*(--strip-debug\fR or
\&\fB\*(--strip-unneeded\fR, retain any symbols specifying source file names,
which would otherwise get stripped.
.Ip "\fB\*(--only-keep-debug\fR" 4
.IX Item "only-keep-debug"
Strip a file, removing any sections that would be stripped by
\&\fB\*(--strip-debug\fR and leaving the debugging sections.
.Sp
The intention is that this option will be used in conjunction with
\&\fB\*(--add-gnu-debuglink\fR to create a two part executable.  One a
stripped binary which will occupy less space in \s-1RAM\s0 and in a
distribution and the second a debugging information file which is only
needed if debugging abilities are required.  The suggested procedure
to create these files is as follows:
.RS 4
.Ip "1.<Link the executable as normal.  Assuming that is is called>" 4
.IX Item "1.<Link the executable as normal.  Assuming that is is called>"
\&\f(CW\*(C`foo\*(C'\fR then...
.if n .Ip "1.<Run \f(CW""""objcopy \-\-only\-keep\-debug foo foo.dbg""""\fR to>" 4
.el .Ip "1.<Run \f(CWobjcopy \-\-only\-keep\-debug foo foo.dbg\fR to>" 4
.IX Item "1.<Run objcopy --only-keep-debug foo foo.dbg to>"
create a file containing the debugging info.
.if n .Ip "1.<Run \f(CW""""objcopy \-\-strip\-debug foo""""\fR to create a>" 4
.el .Ip "1.<Run \f(CWobjcopy \-\-strip\-debug foo\fR to create a>" 4
.IX Item "1.<Run objcopy --strip-debug foo to create a>"
stripped executable.
.if n .Ip "1.<Run \f(CW""""objcopy \-\-add\-gnu\-debuglink=foo.dbg foo""""\fR>" 4
.el .Ip "1.<Run \f(CWobjcopy \-\-add\-gnu\-debuglink=foo.dbg foo\fR>" 4
.IX Item "1.<Run objcopy --add-gnu-debuglink=foo.dbg foo>"
to add a link to the debugging info into the stripped executable.
.RE
.RS 4
.Sp
Note \- the choice of \f(CW\*(C`.dbg\*(C'\fR as an extension for the debug info
file is arbitrary.  Also the \f(CW\*(C`\-\-only\-keep\-debug\*(C'\fR step is
optional.  You could instead do this:
.RS 4
.RE
.Ip "1.<Link the executable as normal.>" 4
.IX Item "1.<Link the executable as normal.>"
.PD 0
.if n .Ip "1.<Copy \f(CW""""foo""""\fR to  \f(CW""""foo.full""""\fR>" 4
.el .Ip "1.<Copy \f(CWfoo\fR to  \f(CWfoo.full\fR>" 4
.IX Item "1.<Copy foo to  foo.full>"
.if n .Ip "1.<Run \f(CW""""strip \-\-strip\-debug foo""""\fR>" 4
.el .Ip "1.<Run \f(CWstrip \-\-strip\-debug foo\fR>" 4
.IX Item "1.<Run strip --strip-debug foo>"
.if n .Ip "1.<Run \f(CW""""objcopy \-\-add\-gnu\-debuglink=foo.full foo""""\fR>" 4
.el .Ip "1.<Run \f(CWobjcopy \-\-add\-gnu\-debuglink=foo.full foo\fR>" 4
.IX Item "1.<Run objcopy --add-gnu-debuglink=foo.full foo>"
.RE
.RS 4
.PD
.Sp
ie the file pointed to by the \fB\*(--add-gnu-debuglink\fR can be the
full executable.  It does not have to be a file created by the
\&\fB\*(--only-keep-debug\fR switch.
.RE
.Ip "\fB\-V\fR" 4
.IX Item "-V"
.PD 0
.Ip "\fB\*(--version\fR" 4
.IX Item "version"
.PD
Show the version number for \fBstrip\fR.
.Ip "\fB\-v\fR" 4
.IX Item "-v"
.PD 0
.Ip "\fB\*(--verbose\fR" 4
.IX Item "verbose"
.PD
Verbose output: list all object files modified.  In the case of
archives, \fBstrip \-v\fR lists all members of the archive.
.Ip "\fB@\fR\fIfile\fR" 4
.IX Item "@file"
Read command-line options from \fIfile\fR.  The options read are
inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
does not exist, or cannot be read, then the option will be treated
literally, and not removed.  
.Sp
Options in \fIfile\fR are separated by whitespace.  A whitespace
character may be included in an option by surrounding the entire
option in either single or double quotes.  Any character (including a
backslash) may be included by prefixing the character to be included
with a backslash.  The \fIfile\fR may itself contain additional
@\fIfile\fR options; any such options will be processed recursively.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
the Info entries for \fIbinutils\fR.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
2000, 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
or any later version published by the Free Software Foundation;
with no Invariant Sections, with no Front-Cover Texts, and with no
Back-Cover Texts.  A copy of the license is included in the
section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".