OBJCOPY(1)
๐ NAME ๐
okay so bestie, meet objcopy โ she's a GNU Development Tools girlie, and yes, this is her OBJCOPY(1) manual page. Her whole entire job? copy and translate object files. That's it. That's the girl. โจ
๐ SYNOPSIS ๐
like, here's the whole vibe of how you'd actually call her:
objcopy [-F bfdname|--target=bfdname]
[-I bfdname|--input-target=bfdname]
[-O bfdname|--output-target=bfdname]
[-B bfdarch|--binary-architecture=bfdarch]
[-S|--strip-all]
[-g|--strip-debug]
[--strip-unneeded]
[-K symbolname|--keep-symbol=symbolname]
[--keep-file-symbols]
[--keep-section-symbols]
[-N symbolname|--strip-symbol=symbolname]
[--strip-unneeded-symbol=symbolname]
[-G symbolname|--keep-global-symbol=symbolname]
[--localize-hidden]
[-L symbolname|--localize-symbol=symbolname]
[--globalize-symbol=symbolname]
[--globalize-symbols=filename]
[-W symbolname|--weaken-symbol=symbolname]
[-w|--wildcard]
[-x|--discard-all]
[-X|--discard-locals]
[-b byte|--byte=byte]
[-i [breadth]|--interleave[=breadth]]
[--interleave-width=width]
[-j sectionpattern|--only-section=sectionpattern]
[-R sectionpattern|--remove-section=sectionpattern]
[--keep-section=sectionpattern]
[--remove-relocations=sectionpattern]
[--strip-section-headers]
[-p|--preserve-dates]
[-D|--enable-deterministic-archives]
[-U|--disable-deterministic-archives]
[--debugging]
[--gap-fill=val]
[--pad-to=address]
[--set-start=val]
[--adjust-start=incr]
[--change-addresses=incr]
[--change-section-address sectionpattern{=,+,-}val]
[--change-section-lma sectionpattern{=,+,-}val]
[--change-section-vma sectionpattern{=,+,-}val]
[--change-warnings] [--no-change-warnings]
[--set-section-flags sectionpattern=flags]
[--set-section-alignment sectionpattern=align]
[--add-section sectionname=filename]
[--dump-section sectionname=filename]
[--update-section sectionname=filename]
[--rename-section oldname=newname[,flags]]
[--long-section-names {enable,disable,keep}]
[--change-leading-char] [--remove-leading-char]
[--reverse-bytes=num]
[--srec-len=ival] [--srec-forceS3]
[--redefine-sym old=new]
[--redefine-syms=filename]
[--weaken]
[--keep-symbols=filename]
[--strip-symbols=filename]
[--strip-unneeded-symbols=filename]
[--keep-global-symbols=filename]
[--localize-symbols=filename]
[--weaken-symbols=filename]
[--binary-symbol-prefixstring]
[--add-symbol name=[section:]value[,flags]]
[--alt-machine-code=index]
[--prefix-symbols=string]
[--prefix-sections=string]
[--prefix-alloc-sections=string]
[--add-gnu-debuglink=path-to-file]
[--only-keep-debug]
[--strip-dwo]
[--extract-dwo]
[--extract-symbol]
[--writable-text]
[--readonly-text]
[--pure]
[--impure]
[--file-alignment=num]
[--heap=reserve[,commit]]
[--image-base=address]
[--section-alignment=num]
[--stack=reserve[,commit]
[--subsystem=which:major.minor]
[--compress-debug-sections]
[--decompress-debug-sections]
[--elf-stt-common=val]
[--merge-notes]
[--no-merge-notes]
[--verilog-data-width=val]
[-v|--verbose]
[-V|--version]
[--help] [--info]
infile [outfile]
(yes she has a LOT of flags. she's an overachiever. we love her for it. ๐ )
๐ธ DESCRIPTION ๐ธ
So the tea: the GNU objcopy utility copies the contents of one object file into another one. That's the whole plot. ๐ซถ
objcopy uses the GNU BFD Library to read and write the object files, which is how she's able to write the destination object file in a format that's completely different from the source file's format. What exactly she does is controlled by the command-line options you hand her. And ngl, there's a caveat here:
Note that objcopy should be able to copy a fully linked file between any two formats. However, copying a relocatable object file between any two formats may not work as expected. ๐ญ so don't come for her if that one acts up.
When she's doing her translations, objcopy creates temporary files and then deletes them afterward. She does all the translation work with BFD, which means she has access to every single format described in BFD, so she can recognize most formats without you having to tell her what they are. She just knows. main character energy honestly. โจ
You can also use objcopy to generate S-records by setting the output target to srec (like, do -O srec).
And you can use objcopy to generate a raw binary file by setting the output target to binary (like, do -O binary). When she generates a raw binary file, she basically produces a memory dump of the contents of the input object file. Heads up though:
- All symbols and relocation information will be discarded. gone. poof. ๐
- The memory dump will start at the load address of the lowest section that got copied into the output file.
When you're generating an S-record or a raw binary file, it may be helpful to use -S to remove sections that contain debugging information. And in some cases -R will be useful for removing sections that contain information the binary file just doesn't need. ๐ง
Note โ and this is important bestie:objcopyis not able to change the endianness of its input files. If the input format has an endianness (some formats don't),objcopycan only copy the inputs into file formats that have the same endianness or that have no endianness at all (e.g.,srec). (However, see the--reverse-bytesoption. ๐)
โจ OPTIONS โจ
okay this is the long part, buckle up, we're going option by option and I'm not skipping a single one. ๐
infile,outfileโ the input and output files, respectively. If you don't specifyoutfile,objcopycreates a temporary file and then destructively renames the result using the name ofinfile. so like, she will overwrite your input file. be aware. ๐ญ-I bfdname,--input-target=bfdnameโ treat the source file's object format asbfdnameinstead of trying to figure it out herself.-O bfdname,--output-target=bfdnameโ write the output file using the object formatbfdname.-F bfdname,--target=bfdnameโ usebfdnameas the object format for both the input and the output file; i.e., just transfer the data from source to destination with no translation at all. lazy girl behavior and honestly, valid. ๐-B bfdarch,--binary-architecture=bfdarchโ this one's useful when you're transforming an architecture-less input file into an object file. In that case the output architecture can be set tobfdarch. This option gets ignored if the input file already has a knownbfdarch. You can access this binary data inside a program by referencing the special symbols created by the conversion process, which are called_binary_objfile_start,_binary_objfile_endand_binary_objfile_size. e.g. you can transform a picture file into an object file and then access it in your code using these symbols. ๐ธ-j sectionpattern,--only-section=sectionpatternโ copy only the indicated sections from the input file to the output file. This option may be given more than once. โ ๏ธ Note that using this option inappropriately may make the output file unusable. Wildcard characters are accepted in sectionpattern.
If the first character of sectionpattern is the exclamation point (!), then matching sections will not be copied, even if an earlier use of --only-section on the same command line would otherwise copy it. For example:
--only-section=.text.* --only-section=!.text.foo
will copy all sections matching .text.* but not the section .text.foo.
-R sectionpattern,--remove-section=sectionpatternโ remove any section matching sectionpattern from the output file. This option may be given more than once. โ ๏ธ Note that using this option inappropriately may make the output file unusable. Wildcard characters are accepted in sectionpattern.
Using both the-jand-Roptions together results in undefined behaviour. do not do this. ๐
If the first character of sectionpattern is the exclamation point (!), then matching sections will not be removed, even if an earlier use of --remove-section on the same command line would otherwise remove it. For example:
--remove-section=.text.* --remove-section=!.text.foo
will remove all sections matching the pattern .text.*, but will not remove the section .text.foo.
--keep-section=sectionpatternโ when removing sections from the output file, keep the sections that match sectionpattern. ๐ซถ--remove-relocations=sectionpatternโ remove non-dynamic relocations from the output file for any section matching sectionpattern. This option may be given more than once. โ ๏ธ Note that using this option inappropriately may make the output file unusable, and attempting to remove a dynamic relocation section such as.rela.pltfrom an executable or shared library with--remove-relocations=.pltwill not work. Wildcard characters are accepted in sectionpattern. For example:
--remove-relocations=.text.*
will remove the relocations for all sections matching the pattern .text.*.
If the first character of sectionpattern is the exclamation point (!), then matching sections will not have their relocation removed, even if an earlier use of --remove-relocations on the same command line would otherwise cause the relocations to be removed. For example:
--remove-relocations=.text.* --remove-relocations=!.text.foo
will remove all relocations for sections matching the pattern .text.*, but will not remove relocations for the section .text.foo.
--strip-section-headersโ strip the section headers. This option is specific to ELF files. It implies--strip-alland--merge-notes. ๐ฅ-S,--strip-allโ do not copy relocation and symbol information from the source file. Also deletes debug sections. she's taking it ALL off. ๐-g,--strip-debugโ do not copy debugging symbols or sections from the source file.--strip-unneededโ remove all symbols that are not needed for relocation processing, in addition to the debugging symbols and sections already stripped by--strip-debug.-K symbolname,--keep-symbol=symbolnameโ when stripping symbols, keep the symbol symbolname even if it would normally get stripped. This option may be given more than once. ๐ฅบ-N symbolname,--strip-symbol=symbolnameโ do not copy the symbol symbolname from the source file. This option may be given more than once.--strip-unneeded-symbol=symbolnameโ do not copy the symbol symbolname from the source file unless it is needed by a relocation. This option may be given more than once.
okay and that's just part one bestie, there's SO much more coming, stay with me ๐
-G symbolname,--keep-global-symbol=symbolnameโ bestie, this one keeps onlysymbolnameglobal ๐ and makes every other symbol local to the file so they are not visible externally. You can drop this option more than once. Note: this option cannot be used in conjunction with the--globalize-symbolor--globalize-symbolsoptions. Periodt.--localize-hiddenโ in an ELF object, mark all symbols that have hidden or internal visibility as local. This option applies on top of symbol-specific localization options such as-L. Slay.-L symbolname,--localize-symbol=symbolnameโ convert a global or weak symbol calledsymbolnameinto a local symbol, so that it is not visible externally. This option may be given more than once. Note - unique symbols are not converted. Lowkey important.-W symbolname,--weaken-symbol=symbolnameโ make symbolsymbolnameweak. This option may be given more than once. Iconic.--binary-symbol-prefix=stringโ when used with--input-target=binary, setsstringas the base name for the symbols generated for the input file. These symbols are:
<string>_start
<string>_end
<string>_size
By default, the binary input handler derives the prefix symbol name from a mangled version of the input file name and _binary prefix. This option allows specifying it explicitly. Obsessed.
--globalize-symbol=symbolnameโ give symbolsymbolnameglobal scoping so that it is visible outside of the file in which it is defined. This option may be given more than once. Note: this option cannot be used in conjunction with the-Gor--keep-global-symboloptions. No cap.-w,--wildcardโ permit regular expressions in symbolnames used in other command line options. The question mark (?), asterisk (*), backslash (\) 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:
-w -W !foo -W fo*
would cause objcopy to weaken all symbols that start with "fo" except for the symbol "foo". The way that works? Chef's kiss.
-x,--discard-allโ do not copy non-global symbols from the source file. Bye.-X,--discard-localsโ do not copy compiler-generated local symbols. (These usually start withLor..) ๐-b byte,--byte=byteโ if interleaving has been enabled via the--interleaveoption then start the range of bytes to keep at thebyteth byte.bytecan be in the range from0tobreadth-1, wherebreadthis the value given by the--interleaveoption. Math but make it fashion.-i [breadth],--interleave[=breadth]โ only copy a range out of everybreadthbytes. (Header data is not affected). Select which byte in the range begins the copy with the--byteoption. Select the width of the range with the--interleave-widthoption. This option is useful for creating files to program ROM. It is typically used with an"srec"output target. Note that objcopy will complain if you do not specify the--byteoption as well. The default interleave breadth is4, so with--byteset to0, objcopy would copy the first byte out of every four bytes from the input to the output. So specific.--interleave-width=widthโ when used with the--interleaveoption, copywidthbytes at a time. The start of the range of bytes to be copied is set by the--byteoption, and the extent of the range is set with the--interleaveoption. The default value for this option is1. The value ofwidthplus thebytevalue set by the--byteoption must not exceed the interleavebreadthset by the--interleaveoption. This option can be used to create images for two 16-bit flashes interleaved in a 32-bit bus by passing-b 0 -i 4 --interleave-width=2and-b 2 -i 4 --interleave-width=2to two objcopy commands. If the input was'12345678'then the outputs would be'1256'and'3478'respectively. That is actually so cool.-p,--preserve-datesโ set the access and modification dates of the output file to be the same as those of the input file. This option also copies the date stored in a PE format file's header, unless theSOURCE_DATE_EPOCHenvironment variable is defined. If it is defined then this variable will be used as the date stored in the header, interpreted as the number of seconds since the Unix epoch. Time travel but make it Unix.-D,--enable-deterministic-archivesโ operate in deterministic mode. When copying archive members and writing the archive index, use zero for UIDs, GIDs, timestamps, and use consistent file modes for all files. If binutils was configured with--enable-deterministic-archives, then this mode is on by default. It can be disabled with the-Uoption, below. Deterministic queen.-U,--disable-deterministic-archivesโ do not operate in deterministic mode. This is the inverse of the-Doption, above: when copying archive members and writing the archive index, use their actual UID, GID, timestamp, and file mode values. This is the default unless binutils was configured with--enable-deterministic-archives. No filter.--debuggingโ convert debugging information, if possible. This is not the default because only certain debugging formats are supported, and the conversion process can be time consuming. Patience.--gap-fill valโ fill gaps between sections withval. This operation applies to the load address (LMA) of the sections. It is done by increasing the size of the section with the lower address, and filling in the extra space created withval. Fill her up.--pad-to addressโ pad the output file up to the load addressaddress. This is done by increasing the size of the last section. The extra space is filled in with the value specified by--gap-fill(default zero). Pad it out.--set-start valโ set the start address (also known as the entry address) of the new file toval. Not all object file formats support setting the start address. Main character entry.--change-start incr,--adjust-start incrโ change the start address (also known as the entry address) by addingincr. Not all object file formats support setting the start address. Shift it.--change-addresses incr,--adjust-vma incrโ change the VMA and LMA addresses of all sections, as well as the start address, by addingincr. Some object file formats do not permit section addresses to be changed arbitrarily. Note that this does not relocate the sections; if the program expects sections to be loaded at a certain address, and this option is used to change the sections such that they are loaded at a different address, the program may fail. > โ ๏ธ Dangerous if you do not know what you are doing.--change-section-address sectionpattern{=,+,-}val,--adjust-section-vma sectionpattern{=,+,-}valโ set or change both the VMA address and the LMA address of any section matchingsectionpattern. If=is used, the section address is set toval. Otherwise,valis added to or subtracted from the section address. See the comments under--change-addresses, above. Ifsectionpatterndoes not match any sections in the input file, a warning will be issued, unless--no-change-warningsis used. Pattern matching realness.--change-section-lma sectionpattern{=,+,-}valโ set or change the LMA address of any sections matchingsectionpattern. The LMA address is the address where the section will be loaded into memory at program load time. Normally this is the same as the VMA address, which is the address of the section at program run time, but on some systems, especially those where a program is held in ROM, the two can be different. If=is used, the section address is set toval. Otherwise,valis added to or subtracted from the section address. See the comments under--change-addresses, above. Ifsectionpatterndoes not match any sections in the input file, a warning will be issued, unless--no-change-warningsis used. LMA lore.--change-section-vma sectionpattern{=,+,-}valโ set or change the VMA address of any section matchingsectionpattern. The VMA address is the address where the section will be located once the program has started executing. Normally this is the same as the LMA address, which is the address where the section will be loaded into memory, but on some systems, especially those where a program is held in ROM, the two can be different. If=is used, the section address is set toval. Otherwise,valis added to or subtracted from the section address. See the comments under--change-addresses, above. Ifsectionpatterndoes not match any sections in the input file, a warning will be issued, unless--no-change-warningsis used. > โ ๏ธ Note - changing the VMA of sections in a fully linked binary can be dangerous since there may be code that expects the sections to be located at their old address. Be careful bestie.--change-warnings,--adjust-warningsโ if--change-section-addressor--change-section-lmaor--change-section-vmais used, and the section pattern does not match any sections, issue a warning. This is the default. Warning queen.--no-change-warnings,--no-adjust-warningsโ do not issue a warning if--change-section-addressor--adjust-section-lmaor--adjust-section-vmais used, even if the section pattern does not match any sections. Silent mode.--set-section-flags sectionpattern=flagsโ set the flags for any sections matchingsectionpattern. Theflagsargument is a comma separated string of flag names. The recognized names arealloc,contents,load,noload,readonly,code,data,rom,exclude,share,debug, andlarge. You can set thecontentsflag for a section which does not have contents, but it is not meaningful to clear thecontentsflag of a section which does have contents--just remove the section instead. Not all flags are meaningful for all object file formats. In particular theshareflag is only meaningful for COFF format files and not for ELF format files. The ELF x86-64 specific flaglargecorresponds toSHF_X86_64_LARGE. Flags for days.--set-section-alignment sectionpattern=alignโ set the alignment for any sections matchingsectionpattern.alignspecifies the alignment in bytes and must be a power of two, i.e.1,2,4,8.... Alignment is key.
okay so real quick before we move on โ setting a section's alignment will not magically align its LMA or VMA addresses too, they're separate things bestie ๐ญ. If those actually need changing, that's what --change-section-lma and/or --change-section-vma are for. And also โ heads up โ changing VMAs can cause problems in fully linked binaries, because there may be code in there that just expects the contents of the sections to be sitting at their old address. it will simply not vibe with the new address ๐.
--add-section sectionname=filenameโ adds a brand new section called sectionname while it's copying the file ๐. The contents of this new section come straight from the file filename, and the size of the section will be the size of that file. tiny detail, huge deal: this only works on file formats that can actually support sections with arbitrary names. Also, you may need to reach for--set-section-flagsto set the attributes of the freshly created section, otherwise it's just kinda standing there with no flags ๐.--dump-section sectionname=filenameโ takes the contents of the section named sectionname and drops them into the file filename, overwriting whatever was already chilling in there. This is the inverse of--add-section. It's also similar to--only-section, except it doesn't create a formatted file โ it just dumps the contents as raw binary data, with zero relocations applied. raw. unfiltered. no makeup. You can specify this option more than once โจ.--update-section sectionname=filenameโ swaps out the existing contents of the section named sectionname with the contents of the file filename. The section's size gets adjusted to the size of the file. The section flags for sectionname stay unchanged ๐ซถ. And for ELF format files, the section-to-segment mapping also remains unchanged โ which is something you literally cannot pull off with--remove-sectionfollowed by--add-section. You can specify this option more than once.
note โ you can use--rename-sectionand--update-sectiontogether to both update and rename a section from one command line, iconic behavior honestly ๐. In that case: pass the original section name to--update-section, and pass both the original and new section names to--rename-section.
--add-symbol name=[section:]value[,flags]โ adds a new symbol called name while copying the file. May be specified multiple times ๐ . If the section is given, the symbol gets associated with that section and is relative to it โ otherwise it's anABSsymbol. Specifying an undefined section will result in a fatal error ๐ญ. There is no check for the value; it will be taken as specified, no questions asked. Symbol flags can be specified, but not all flags will be meaningful for all object file formats. By default, the symbol will be global. And the special flagbefore=othersymwill insert the new symbol in front of the specified othersym โ otherwise the symbol(s) get added at the end of the symbol table in the order they appear โจ.--rename-section oldname=newname[,flags]โ renames a section from oldname to newname, optionally changing the section's flags to flags while it's at it. The advantage over using a linker script to do the rename is that the output stays as an object file and does not become a linked executable ๐ธ. This option accepts the same set of flags as--set-section-flags.
This one is particularly helpful when the input format is binary, because binary input will always create a section called .data ๐. So if, for example, you wanted to instead create a section called .rodata containing binary data, you could use the following command line to achieve it:
objcopy -I binary -O <output_format> -B <architecture> \
--rename-section .data=.rodata,alloc,load,readonly,data,contents \
<input_binary_file> <output_object_file>
--long-section-names {enable,disable,keep}โ controls the handling of long section names when processing"COFF"and"PE-COFF"object formats. The default behaviour,keep, is to preserve long section names if any are present in the input file. Theenableanddisableoptions forcibly enable or disable the use of long section names in the output object; whendisableis in effect, any long section names in the input object will be truncated. Theenableoption will only emit long section names if any are present in the inputs โ mostly the same askeep, but it's left undefined whetherenablemight force the creation of an empty string table in the output file ๐คท (mysterious. we love that for it).--change-leading-charโ some object file formats use special characters at the start of symbols. The most common such character is underscore, which compilers often add before every symbol. This option tellsobjcopyto change the leading character of every symbol when it converts between object file formats โจ. If the object file formats use the same leading character, this option has no effect. Otherwise, it will add a character, or remove a character, or change a character, as appropriate ๐ .--remove-leading-charโ if the first character of a global symbol is a special symbol leading character used by the object file format, remove the character. The most common symbol leading character is underscore, so this option will remove a leading underscore from all global symbols ๐. This can be useful if you want to link together objects of different file formats with different conventions for symbol names. It's different from--change-leading-charbecause it always changes the symbol name when appropriate, regardless of the object file format of the output file.--reverse-bytes=numโ reverses the bytes in a section with output contents. A section's length must be evenly divisible by the value given in order for the swap to be able to take place ๐ซถ. And reversing takes place before the interleaving is performed.
This option is typically used when generating ROM images for problematic target systems ๐ญ. For example, on some target boards, the 32-bit words fetched from 8-bit ROMs are re-assembled in little-endian byte order regardless of the CPU byte order. Depending on the programming model, the endianness of the ROM may need to be modified.
Consider a simple file with a section containing the following eight bytes: 12345678.
Using --reverse-bytes=2 for the above example, the bytes in the output file would be ordered 21436587.
Using --reverse-bytes=4 for the above example, the bytes in the output file would be ordered 43218765.
By using --reverse-bytes=2 for the above example, followed by --reverse-bytes=4 on the output file, the bytes in the second output file would be ordered 34127856 ๐คฏ.
--srec-len=ivalโ meaningful only for srec output. Sets the maximum length of the Srecords being produced to ival. This length covers both address, data and crc fields โจ.--srec-forceS3โ meaningful only for srec output. Avoids generation of S1/S2 records, creating S3-only record format ๐ .--redefine-sym old=newโ changes the name of a symbol old, to new. This can be useful when you're trying to link two things together for which you have no source, and there are name collisions ๐ญ the classic "we don't have the source and everything is called the same thing" situation.--redefine-syms=filenameโ applies--redefine-symto each symbol pair"old new"listed in the file filename. filename is simply a flat file, with one symbol pair per line ๐. Line comments may be introduced by the hash character. This option may be given more than once.--weakenโ changes all global symbols in the file to be weak. This can be useful when building an object which will be linked against other objects using the-Roption to the linker. This option is only effective when using an object file format which supports weak symbols โจ.--keep-symbols=filenameโ applies--keep-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character ๐ซถ. This option may be given more than once.--strip-symbols=filenameโ applies--strip-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once โจ.--strip-unneeded-symbols=filenameโ applies--strip-unneeded-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once ๐ธ.--keep-global-symbols=filenameโ applies--keep-global-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once ๐ .--localize-symbols=filenameโ applies--localize-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once ๐.--globalize-symbols=filenameโ applies--globalize-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once. Note: this option cannot be used in conjunction with the-Gor--keep-global-symboloptions โ pick a lane bestie ๐ญ.--weaken-symbols=filenameโ applies--weaken-symbolto each symbol listed in the file filename. filename is simply a flat file, with one symbol name per line. Line comments may be introduced by the hash character. This option may be given more than once โจ.--alt-machine-code=indexโ if the output architecture has alternate machine codes, use the indexth code instead of the default one ๐. This is useful in case a machine is assigned an official code and the tool-chain adopts the new code, but other applications still depend on the original code being used. For ELF based architectures, if the index alternative does not exist, then the value is treated as an absolute number to be stored in thee_machinefield of the ELF header ๐.--writable-textโ marks the output text as writable. This option isn't meaningful for all object file formats ๐คท.--readonly-textโ makes the output text write protected. This option isn't meaningful for all object file formats ๐ .--pureโ marks your output file as demand paged ๐ซถ. Okay but real talk: this option isn't meaningful for all object file formats, so don't come for it if it does nothing on yours.--impureโ marks your output file as impure ๐. Same lil disclaimer: not meaningful for all object file formats.--prefix-symbols=stringโ glues string onto the front of every single symbol in the output file. All of them. No cap. โจ--prefix-sections=stringโ same energy but for section names: every section name in the output file gets string slapped on the front ๐--prefix-alloc-sections=stringโ and this one prefixes the names of all the allocated sections in the output file with string. Just the allocated ones, bestie, we're being specific ๐--add-gnu-debuglink=path-to-fileโ creates a.gnu_debuglinksection that references path-to-file and drops it into the output file ๐. Lowkey important: the file at path-to-file must exist. Part of adding this section is embedding a checksum of the contents of the debug info file into the section, so yeah, it needs the actual file.
Now listen, this is the part people trip on ๐: if the debug info file is built in one location but it's getting installed somewhere else later, do not use the path to the installed location. The --add-gnu-debuglink option will fail, because the installed file doesn't exist yet. Instead, put the debug info file in the current directory and use --add-gnu-debuglink with no directory components at all, like this:
objcopy --add-gnu-debuglink=foo.debug
At debug time, the debugger goes looking for the separate debug info file in a bunch of known locations. The exact set varies by distribution, but it typically includes:
- The same directory as the executable.
- A sub-directory of the directory containing the executable called
.debug - A global debug directory such as
/usr/lib/debug.
As long as the debug info file has been installed into one of those spots before the debugger runs, everything should work correctly ๐
--keep-section-symbolsโ when you're stripping a file (maybe with--strip-debugor--strip-unneeded), this keeps any symbols that specify section names โ the ones that would otherwise get stripped away ๐--keep-file-symbolsโ same deal, but for symbols specifying source file names. Those would otherwise get stripped; this keeps them safe ๐--only-keep-debugโ strips a file by removing the contents of any sections that--strip-debugwould not strip, and leaves the debugging sections intact. In ELF files, this preserves all note sections in the output ๐
Note: the section headers of the stripped sections are preserved โ including their sizes โ but the contents of the section are discarded. Why keep the headers? So other tools can match up the debuginfo file with the real executable, even if that executable has been relocated to a different address space. Iconic behaviour honestly.
The intention is that this option gets used together with --add-gnu-debuglink to create a two-part executable ๐ซถ: one stripped binary that takes up less space in RAM and in a distribution, and a second debugging information file that's only needed if you actually want to debug. The suggested procedure to create these files goes like this:
- Link the executable as normal. Assuming it's called
foo, then... - Run
objcopy --only-keep-debug foo foo.dbgto create a file containing the debugging info. - Run
objcopy --strip-debug footo create a stripped executable. - Run
objcopy --add-gnu-debuglink=foo.dbg footo add a link to the debugging info into the stripped executable.
Note โ the choice of .dbg as an extension for the debug info file is arbitrary, fr fr. Also the --only-keep-debug step is optional. You could instead do this:
- Link the executable as normal.
- Copy
footofoo.full - Run
objcopy --strip-debug foo - Run
objcopy --add-gnu-debuglink=foo.full foo
i.e., the file pointed to by --add-gnu-debuglink can be the full executable โ it does not have to be a file created by the --only-keep-debug switch โจ
Note โ this switch is only intended for use on fully linked files. It does not make sense to use it on object files where the debugging information may be incomplete. Besides, the gnu_debuglink feature currently only supports the presence of one filename containing debugging information โ not multiple filenames on a one-per-object-file basis. So don't try it ๐
--strip-dwoโ removes the contents of all DWARF.dwosections, leaving the remaining debugging sections and all symbols intact ๐ง. This one's intended for the compiler to use as part of the-gsplit-dwarfoption, which splits debug info between the.ofile and a separate.dwofile. The compiler generates all the debug information in the same file, then uses--extract-dwoto copy the.dwosections to the.dwofile, then--strip-dwoto remove those sections from the original.ofile. Clean up after yourself, periodt ๐--extract-dwoโ extracts the contents of all DWARF.dwosections. Peep the--strip-dwooption above for the full lore ๐--file-alignment numโ specifies the file alignment. Sections in the file will always begin at file offsets that are multiples of this number. Defaults to512. [This option is specific to PE targets.]--heap reserveand--heap reserve,commitโ specifies the number of bytes of memory to reserve (and optionally commit) to be used as heap for this program ๐ง [This option is specific to PE targets.]--image-base valueโ uses value as the base address of your program or dll. This is the lowest memory location that gets used when your program or dll is loaded ๐. To reduce the need to relocate and improve performance of your dlls, each one should have a unique base address and not overlap any other dlls โ main character energy only, no overlap bestie. The default is0x400000for executables, and0x10000000for dlls. [This option is specific to PE targets.]--section-alignment numโ [This option is specific to PE targets.]
Sets the section alignment field in the PE header โ if one is present in the binary. Sections in memory will always begin at addresses that are a multiple of this number. Defaults to 0x1000.
Note โ if a section's LMA or VMA addresses are no longer aligned, and those addresses haven't been set via the--set-section-lmaor--set-section-vmaoptions, and the file has been fully relocated, then a warning message will be issued. It's then up to you to decide if the LMA and VMA need updating. Good luck with that ๐
--stack reserveand--stack reserve,commitโ specifies the number of bytes of memory to reserve (and optionally commit) to be used as stack for this program ๐ฅ [This option is specific to PE targets.]--subsystem which,--subsystem which:major,--subsystem which:major.minorโ specifies the subsystem under which your program will execute ๐ฎ. The legal values for which are"native","windows","console","posix","efi-app","efi-bsd","efi-rtd","sal-rtd", and"xbox". You may optionally set the subsystem version too. Numeric values are also accepted for which. [This option is specific to PE targets.]--extract-symbolโ keeps the file's section flags and symbols but removes all section data ๐งน. Specifically, the option:- removes the contents of all sections;
- sets the size of every section to zero; and
- sets the file's start address to zero.
This option is used to build a .sym file for a VxWorks kernel. It can also be a useful way of reducing the size of a --just-symbols linker input file ๐ซถ
--compress-debug-sectionsโ compresses DWARF debug sections using zlib withSHF_COMPRESSEDfrom the ELF ABI ๐๏ธ. Note โ if compression would actually make a section larger, then it is not compressed. Common sense, we love to see it.--compress-debug-sections=none,--compress-debug-sections=zlib,--compress-debug-sections=zlib-gnu,--compress-debug-sections=zlib-gabi,--compress-debug-sections=zstdโ for ELF files, these control how DWARF debug sections get compressed โจ. Here's the tea:--compress-debug-sections=noneis equivalent to--decompress-debug-sections.--compress-debug-sections=zliband--compress-debug-sections=zlib-gabiare equivalent to--compress-debug-sections.--compress-debug-sections=zlib-gnucompresses DWARF debug sections using the obsoleted zlib-gnu format. The debug sections are renamed to begin with.zdebug.--compress-debug-sections=zstdcompresses DWARF debug sections using zstd.
Note โ if compression would actually make a section larger, then it is not compressed nor renamed ๐
--decompress-debug-sectionsโ decompresses DWARF debug sections. For a.zdebugsection, the original name is restored ๐ธ--elf-stt-common=yesand--elf-stt-common=noโ for ELF files, these control whether common symbols should be converted to the"STT_COMMON"or"STT_OBJECT"type.--elf-stt-common=yesconverts common symbol type to"STT_COMMON".--elf-stt-common=noconverts common symbol type to"STT_OBJECT". Pick your fighter ๐--merge-notesand--no-merge-notesโ for ELF files, attempt (or do not attempt) to reduce the size of anySHT_NOTEtype sections by removing duplicate notes ๐ฉน. Duplicate notes? Not on our watch.-V,--versionโ shows the version number ofobjcopyโญ--verilog-data-width=bytesโ for Verilog output, this controls the number of bytes converted for each output data element. The input target controls the endianness of the conversion ๐-v,--verboseโ verbose output: lists all object files modified ๐ฃ๏ธ. In the case of archives,objcopy -Vlists all members of the archive.--helpโ shows a summary of the options toobjcopy๐โโ๏ธ--infoโ displays a list showing all architectures and object formats available ๐โจ@fileโ reads command-line options from file ๐. The options read are inserted in place of the original@fileoption. If file doesn't exist, or can't be read, then the option gets treated literally, and is not removed. No silent disappearing acts here.
Options in file 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 file may itself contain additional @file options โ any such options will be processed recursively ๐๐ฆ
โจ SEE ALSO โจ
ok so if you liked this you're gonna love the whole friend group ๐
ld(1)โ the linker bestie, brings everything togetherobjdump(1)โ the one who reads the tea back to you, dissects all your objects- and the Info entries for binutils โ like, the extended lore, iykyk ๐ฆ
๐ COPYRIGHT ๐
so like, legally speaking ๐
Copyright (c) 1991-2025 Free Software Foundation, Inc.
you are hereby granted permission to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 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 "GNU Free Documentation License". ๐ซถ
fr fr read the license, it's giving "we trust you, just keep it free" energy and that's iconic of them
okay bestie that's a wrap on the whole page, you made it to the end ๐ โจ
this was binutils-2.45.50, dated 2026-01-13, and it lives under OBJCOPY(1) โ go copy some objects, you absolute main character ๐๐ฆ๐
๐ฆ where this page comes from
- ubuntu resolute: binutils-m68hc1x 1:2.45.50.20251209+3.5.3build1 ยท GPL-3.0-or-later
- ubuntu stonking: binutils-m68hc1x 1:2.45.50.20251209+3.5.3build1 ยท GPL-3.0-or-later
- ๐ girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms