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