binutils/objcopy.1

   1 .\" Copyright (c) 1991 Free Software Foundation
   2 .\" See section COPYING for conditions for redistribution
   3 .TH objcopy 1 "October 1994" "cygnus support" "GNU Development Tools"
   4 .de BP
   5 .sp
   6 .ti \-.2i
   7 \(**
   8 ..
   9
  10 .SH NAME
  11 objcopy \- copy and translate object files
  12
  13 .SH SYNOPSIS
  14 .hy 0
  15 .na
  16 .TP
  17 .B objcopy
  18 .RB "[\|" \-F\ \fIbfdname\fR\ |\ \fB\-\-target=\fIbfdname\fR "\|]"
  19 .RB "[\|" \-I\ \fIbfdname\fR\ |\ \fB\-\-input\-target=\fIbfdname\fR "\|]"
  20 .RB "[\|" \-O\ \fIbfdname\fR\ |\ \fB\-\-output\-target=\fIbfdname\fR "\|]"
  21 .RB "[\|" \-R\ \fIsectionname\fR\ |\ \fB\-\-remove\-section=\fIsectionname\fR "\|]"
  22 .RB "[\|" \-S\fR\ |\ \fB\-\-strip\-all\fR "\|]"
  23 .RB "[\|" \-g\fR\ |\ \fB\-\-strip\-debug\fR "\|]"
  24 .RB "[\|" \-\-strip\-unneeded\fR "\|]"
  25 .RB "[\|" \-K\ \fIsymbolname\fR\ |\ \fB\-\-keep\-symbol=\fIsymbolname\fR "\|]"
  26 .RB "[\|" \-N\ \fIsymbolname\fR\ |\ \fB\-\-strip\-symbol=\fIsymbolname\fR "\|]"
  27 .RB "[\|" \-x\fR\ |\ \fB\-\-discard\-all\fR "\|]"
  28 .RB "[\|" \-X\fR\ |\ \fB\-\-discard\-locals\fR "\|]"
  29 .RB "[\|" \-b\ \fIbyte\fR\ |\ \fB\-\-byte=\fIbyte\fR "\|]"
  30 .RB "[\|" \-i\ \fIinterleave\fR\ |\ \fB\-\-interleave=\fIinterleave\fR "\|]"
  31 .RB "[\|" \-\-debugging "\|]"
  32 .RB "[\|" \-\-gap\-fill=\fIval\fR "\|]"
  33 .RB "[\|" \-\-pad\-to=\fIaddress\fR "\|]"
  34 .RB "[\|" \-\-set\-start=\fIval\fR "\|]"
  35 .RB "[\|" \-\-adjust\-start=\fIincr\fR "\|]"
  36 .RB "[\|" \-\-adjust\-vma=\fIincr\fR "\|]"
  37 .RB "[\|" \-\-adjust\-section\-vma=\fIsection{=,+,-}val\fR "\|]"
  38 .RB "[\|" \-\-adjust\-warnings\fR "\|]"
  39 .RB "[\|" \-\-no\-adjust\-warnings\fR "\|]"
  40 .RB "[\|" \-\-set\-section\-flags=\fIsection=flags\fR "\|]"
  41 .RB "[\|" \-\-add\-section=\fIsectionname=filename\fR "\|]"
  42 .RB "[\|" \-v\ |\ \-\-verbose\fR "\|]"
  43 .RB "[\|" \-V\ |\ \-\-version\fR "\|]"
  44 .RB "[\|" \-\-help\fR "\|]"
  45 .B infile
  46 .RB "[\|" outfile\fR "\|]"
  47 .SH DESCRIPTION
  48 The GNU
  49 .B objcopy
  50 utility copies the contents of an object file to another.
  51 .B objcopy
  52 uses the GNU BFD Library to read and write the object files.  It can
  53 write the destination object file in a format different from that of
  54 the source object file.  The exact behavior of
  55 .B objcopy
  56 is controlled by command-line options.
  57 .PP
  58 .B objcopy
  59 creates temporary files to do its translations and deletes them
  60 afterward.
  61 .B objcopy
  62 uses BFD to do all its translation work; it knows about all the
  63 formats BFD knows about, and thus is able to recognize most formats
  64 without being told explicitly.
  65 .PP
  66 .B objcopy
  67 can be used to generate S-records by using an output target of
  68 .B srec
  69 (e.g., use
  70 .B -O srec).
  71 .PP
  72 .B objcopy
  73 can be used to generate a raw binary file by using an output target of
  74 .B binary
  75 (e.g., use
  76 .B -O binary).
  77 When
  78 .B objcopy
  79 generates a raw binary file, it will essentially produce a memory dump
  80 of the contents of the input object file.  All symbols and relocation
  81 information will be discarded.  The memory dump will start at the
  82 virtual address of the lowest section copied into the output file.
  83 .PP
  84 When generating an S-record or a raw binary file, it may be helpful to
  85 use
  86 .B -S
  87 to remove sections containing debugging information.  In some cases
  88 .B -R
  89 will be useful to remove sections which contain information which is
  90 not needed by the binary file.
  91 .PP
  92 .I infile
  93 and
  94 .I outfile
  95 are the source and output files respectively.  If you do not specify
  96 .IR outfile ,
  97 .B objcopy
  98 creates a temporary file and destructively renames the result with the
  99 name of the input file.
 100
 101 .SH OPTIONS
 102 .TP
 103 .B \-I \fIbfdname\fR, \fB\-\-input\-target=\fIbfdname
 104 Consider the source file's object format to be
 105 .IR bfdname ,
 106 rather than attempting to deduce it.
 107 .TP
 108 .B \-O \fIbfdname\fR, \fB\-\-output\-target=\fIbfdname
 109 Write the output file using the object format
 110 .IR bfdname .
 111 .TP
 112 .B \-F \fIbfdname\fR, \fB\-\-target=\fIbfdname
 113 Use
 114 .I bfdname
 115 as the object format for both the input and the output file; i.e.
 116 simply transfer data from source to destination with no translation.
 117 .TP
 118 .B \-R \fIsectionname\fR, \fB\-\-remove-section=\fIsectionname
 119 Remove the named section from the file.  This option may be given more
 120 than once.  Note that using this option inappropriately may make the
 121 output file unusable.
 122 .TP
 123 .B \-S\fR, \fB\-\-strip\-all
 124 Do not copy relocation and symbol information from the source file.
 125 .TP
 126 .B \-g\fR, \fB\-\-strip\-debug
 127 Do not copy debugging symbols from the source file.
 128 .TP
 129 .B \-\-strip\-unneeded
 130 Strip all symbols that are not needed for relocation processing.
 131 .TP
 132 .B \-K \fIsymbolname\fR, \fB\-\-keep\-symbol=\fIsymbolname
 133 Copy only symbol \fIsymbolname\fP from the source file. This option
 134 may be given more than once.
 135 .TP
 136 .B \-N \fIsymbolname\fR, \fB\-\-strip\-symbol=\fIsymbolname
 137 Do not copy symbol \fIsymbolname\fP from the source file. This option
 138 may be given more than once, and may be combined with strip options
 139 other than \fB\-K\fR.
 140 .TP
 141 .B \-x\fR, \fB \-\-discard\-all
 142 Do not copy non-global symbols from the source file.
 143 .TP
 144 .B \-X\fR, \fB\-\-discard\-locals
 145 Do not copy compiler-generated local symbols. (These usually start
 146 with "L" or ".").
 147 .TP
 148 .B \-b \fIbyte\fR, \fB\-\-byte=\fIbyte
 149 Keep only every \fIbyte\fPth byte of the input file (header data is
 150 not affected).  \fIbyte\fP can be in the range from 0 to the
 151 interleave-1.  This option is useful for creating files to program
 152 ROMs.  It is typically used with an srec output target.
 153 .TP
 154 .B \-i \fIinterleave\fR, \fB\-\-interleave=\fIinterleave
 155 Only copy one out of every \fIinterleave\fP bytes.  Which one to copy is
 156 selected by the \fB\-b\fP or \fB\-\-byte\fP option.  The default is 4.
 157 The interleave is ignored if neither \fB\-b\fP nor \fB\-\-byte\fP is given.
 158 .TP
 159 .B \-\-debugging
 160 Convert debugging information, if possible.  This is not the default
 161 because only certain debugging formats are supported, and the
 162 conversion process can be time consuming.
 163 .TP
 164 .B \-\-gap\-fill=\fIval
 165 Fill gaps between sections with \fIval\fP.  This is done by increasing
 166 the size of the section with the lower address, and filling in the extra
 167 space created with \fIval\fP.
 168 .TP
 169 .B \-\-pad\-to=\fIaddress
 170 Pad the output file up to the virtual address \fIaddress\fP.  This is
 171 done by increasing the size of the last section.  The extra space is
 172 filled in with the value specified by \fB\-\-gap\-fill\fP (default
 173 zero).
 174 .TP
 175 .B \fB\-\-set\-start=\fIval
 176 Set the start address of the new file to \fIval\fP.  Not all object
 177 file formats support setting the start address.
 178 .TP
 179 .B \fB\-\-adjust\-start=\fIincr
 180 Adjust the start address by adding \fIincr\fP.  Not all object file
 181 formats support setting the start address.
 182 .TP
 183 .B \fB\-\-adjust\-vma=\fIincr
 184 Adjust the address of all sections, as well as the start address, by
 185 adding \fIincr\fP.  Some object file formats do not permit section
 186 addresses to be changed arbitrarily.  Note that this does not relocate
 187 the sections; if the program expects sections to be loaded at a
 188 certain address, and this option is used to change the sections such
 189 that they are loaded at a different address, the program may fail.
 190 .TP
 191 .B \fB\-\-adjust\-section\-vma=\fIsection{=,+,-}val
 192 Set or adjust the address of the named \fIsection\fP.  If \fI=\fP is
 193 used, the section address is set to \fIval\fP.  Otherwise, \fIval\fP
 194 is added to or subtracted from the section address.  See the comments
 195 under \fB\-\-adjust\-vma\fP, above.  If \fIsection\fP does not exist
 196 in the input file, a warning will be issued, unless
 197 \fB\-\-no\-adjust\-warnings\fP is used.
 198 .TP
 199 .B \fB\-\-adjust\-warnings
 200 If \fB\-\-adjust\-section\-vma\fP is used, and the named section does
 201 not exist, issue a warning.  This is the default.
 202 .TP
 203 .B \fB\-\-no\-adjust\-warnings
 204 Do not issue a warning if \fB\-\-adjust\-section\-vma\fP is used, even
 205 if the named section does not exist.
 206 .TP
 207 .B \fB\-\-set\-section\-flags=\fIsection=flags
 208 Set the flags for the named section.  The \fIflags\fP argument is a
 209 comma separated string of flag names.  The recognized names are
 210 \fIalloc\fP, \fIload\fP, \fIreadonly\fP, \fIcode\fP, \fIdata\fP, and
 211 \fIrom\fP.  Not all flags are meaningful for all object file
 212 formats.
 213 .TP
 214 .B \fB\-\-add\-section=\fIsectionname=filename
 215 Add a new section named \fIsectionname\fR while copying the file.  The
 216 contents of the new section are taken from the file \fIfilename\fR.
 217 The size of the section will be the size of the file.  This option
 218 only works on file formats which can support sections with arbitrary
 219 names.
 220 .TP
 221 .B \-v\fR, \fB\-\-verbose
 222 Verbose output: list all object files modified.  In the case of
 223 archives, "\fBobjcopy \-V\fR" lists all members of the archive.
 224 .TP
 225 .B \-V\fR, \fB\-\-version
 226 Show the version number of
 227 .B objcopy
 228 and exit.
 229 .TP
 230 .B \-\-help
 231 Show a summary of the options to
 232 .B objcopy
 233 and exit.
 234 .SH "SEE ALSO"
 235 .RB "`\|" binutils "\|'"
 236 entry in
 237 .B
 238 info\c
 239 \&;
 240 .I
 241 The GNU Binary Utilities\c
 242 \&, Roland H. Pesch (June 1993).
 243
 244 .SH COPYING
 245 Copyright (c) 1993, 94, 95, 1996 Free Software Foundation, Inc.
 246 .PP
 247 Permission is granted to make and distribute verbatim copies of
 248 this manual provided the copyright notice and this permission notice
 249 are preserved on all copies.
 250 .PP
 251 Permission is granted to copy and distribute modified versions of this
 252 manual under the conditions for verbatim copying, provided that the
 253 entire resulting derived work is distributed under the terms of a
 254 permission notice identical to this one.
 255 .PP
 256 Permission is granted to copy and distribute translations of this
 257 manual into another language, under the above conditions for modified
 258 versions, except that this permission notice may be included in
 259 translations approved by the Free Software Foundation instead of in
 260 the original English.