OBJCOPY(1)
π objcopy β copy and translate object files π
okay so bestie, welcome to objcopy(1) from GNU Development Tools β¨ this is the icon, the main character, the one that copies your object files and translates them between formats. grab a strawberry drink π and let's get into it.
πΈ NAME πΈ
objcopy β copy and translate object files π
β¨ SYNOPSIS β¨
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]
π DESCRIPTION π
The GNU objcopy utility copies the contents of one object file into another. it literally uses the GNU BFD Library to read and write your object files, and it can write the destination in a different format from the source. absolute slay. the exact behavior is controlled by the command-line options, so it's giving customizable π
β οΈ heads up bestie: objcopy should be able to copy a fully linked file between any two formats. but copying a relocatable object file between any two formats may not work as expected. so don't come for her if that particular vibe check fails π
objcopy creates temporary files to do its translations and deletes them afterward π§ it uses BFD for all its translation work β it has access to all the formats described in BFD, so it can recognize most formats without being told explicitly. she just knows π
objcopy can be used to generate S-records by using an output target of srec (e.g., use -O srec). β¨
objcopy can also be used to generate a raw binary file by using an output target of binary (e.g., use -O binary). when objcopy generates a raw binary file, it will essentially produce a memory dump of the contents of the input object file. all symbols and relocation information will be discarded ποΈ and the memory dump will start at the load address of the lowest section copied into the output file.
when generating an S-record or a raw binary file, it may be helpful to use -S to remove sections containing debugging information. in some cases -R will be useful to remove sections which contain information that is not needed by the binary file π₯
π¨ Note βobjcopyis not able to change the endianness of its input files. if the input format has an endianness (some formats do not),objcopycan only copy the inputs into file formats that have the same endianness or which have no endianness (e.g.,srec). (however, see the--reverse-bytesoption π)
π¦ OPTIONS π¦
infile,outfileβ the input and output files, respectively. if you don't specifyoutfile,objcopycreates a temporary file and destructively renames the result with the name ofinfile. (yes, destructively. bestie she's not asking permission π)
π Target & format stuff π
-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., simply transfer data from source to destination with no translation. no thoughts, just vibes π«Ά-B bfdarch,--binary-architecture=bfdarchβ useful when transforming an architecture-less input file into an object file. in this case the output architecture can be set tobfdarch. this option will be ignored if the input file has a knownbfdarch. you can access this binary data inside a program by referencing the special symbols that are created by the conversion process. those symbols 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 πΌοΈβ¨
π Section-y things π
-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 insectionpattern.
if the first character of sectionpattern is the exclamation point (!) then matching sections will not be copied, even if 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. (the original manpage wrote "sectinos" there and honestly? iconic typo, we're preserving the lore π)
-R sectionpattern,--remove-section=sectionpatternβ remove any section matchingsectionpatternfrom 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 insectionpattern. using both the-jand-Roptions together results in undefined behaviour π¨
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 sections that matchsectionpattern. bestie said "not this one, she stays" π«Ά--remove-relocations=sectionpatternβ remove non-dynamic relocations from the output file for any section matchingsectionpattern. 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 insectionpattern. 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 section header. this option is specific to ELF files. implies--strip-alland--merge-notes. π
π Stripping π
-S,--strip-allβ do not copy relocation and symbol information from the source file. also deletes debug sections. gone, reduced to atoms β¨-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 debugging symbols and sections stripped by--strip-debug. lowkey thorough π
π§ Symbol keeping & stripping π§
-K symbolname,--keep-symbol=symbolnameβ when stripping symbols, keep symbolsymbolnameeven if it would normally be stripped. this option may be given more than once. protect her at all costs π«Ά-N symbolname,--strip-symbol=symbolnameβ do not copy symbolsymbolnamefrom the source file. this option may be given more than once.--strip-unneeded-symbol=symbolnameβ do not copy symbolsymbolnamefrom the source file unless it is needed by a relocation. this option may be given more than once.-Gsymbolname,--keep-global-symbol=*symbolname*β bestie, this one says only keepsymbolnameglobal π . Every other symbol gets made local to the file so it's not visible externally anymore. You can pass this more than once, no cap. β οΈ Note: it cannot be used with--globalize-symbolor--globalize-symbolsβ they're literally beefing, don't put them in the same group chat.--localize-hiddenβ in an ELF object, mark all symbols that have hidden or internal visibility as local. It stacks on top of the symbol-specific localization options like-L, so it's giving "yes, and" energy β¨.-Lsymbolname,--localize-symbol=*symbolname*β takes a global or weak symbol calledsymbolnameand makes it a local symbol so it's not visible externally π. Can be given more than once. Note: unique symbols are not converted, periodt.-Wsymbolname,--weaken-symbol=*symbolname*β makessymbolnameweak π«Ά. Also repeatable, because obviously.--binary-symbol-prefix=*string*β when you're running it with--input-target=binary, this setsstringas the base name for the symbols generated for the input file π. Those 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 plus the _binary prefix. This option lets you specify it explicitly instead β main character energy, you decide the name π
.
--globalize-symbol=*symbolname*β givessymbolnameglobal scoping so it's visible outside the file it's defined in π. Repeatable! β οΈ Note: cannot be used with-Gor--keep-global-symbol. Same feud as above, iykyk.-w,--wildcardβ permits regular expressions in the symbolnames used in other command line options π₯. The question mark (?), asterisk (*), backslash (\) and square brackets ([]) operators can be used anywhere in the symbol name. And plot twist: if the first character of the symbol name is an exclamation point (!), the sense of the switch gets 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". Iconic behavior honestly.
-x,--discard-allβ do not copy non-global symbols from the source file. That's it, that's the vibe ποΈ.-X,--discard-localsβ do not copy compiler-generated local symbols. (These usually start withLor..) Bye bestie π-bbyte,--byte=*byte*β if interleaving has been enabled via the--interleaveoption, start the range of bytes to keep at the byteth byte π¦.bytecan be in the range from0to breadth-1, where breadth is the value given by the--interleaveoption.-i[breadth],--interleave[=*breadth*]β only copy a range out of every breadth bytes. (Header data is not affected, don't worry π.) Select which byte in the range begins the copy with the--byteoption, and select the width of the range with the--interleave-widthoption.
This option is useful for creating files to program ROM, which is honestly kinda slay β¨. It's typically used with an "srec" output target. Note that objcopy will complain if you do not specify the --byte option as well π β it's not being mean, it's being honest.
The default interleave breadth is 4, so with --byte set to 0, objcopy would copy the first byte out of every four bytes from the input to the output. Math ate, fr fr.
--interleave-width=*width*β when used with the--interleaveoption, copy width bytes 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 is 1. The value of width plus the byte value set by the --byte option must not exceed the interleave breadth set by the --interleave option β that's a hard rule, no wiggle room π.
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=2 and -b 2 -i 4 --interleave-width=2 to two objcopy commands. If the input was '12345678' then the outputs would be '1256' and '3478' respectively. Look at that, chef's kiss π.
-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 the SOURCE_DATE_EPOCH environment 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. Very demure, very timestamped π.
-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. Consistency is the moment.
If binutils was configured with --enable-deterministic-archives, then this mode is on by default. It can be disabled with the -U option, below π.
-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. Chaotic but valid, we respect it.
--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. Lowkey the lore drop, ngl.--gap-fillval β fill gaps between sections with val π¨. This operation applies to the load address (LMA) of the sections. It's done by increasing the size of the section with the lower address, and filling in the extra space created with val. Filling the void, literally.--pad-toaddress β pad the output file up to the load address address π . 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). Default =0, in case you were wondering π«Ά.--set-startval β set the start address (also known as the entry address) of the new file to val β. Not all object file formats support setting the start address β some of them simply can't, and that's their journey π.--change-startincr,--adjust-startincr β change the start address (also known as the entry address) by adding incr π₯. Same disclaimer as above: not all object file formats support setting the start address.--change-addressesincr,--adjust-vmaincr β change the VMA and LMA addresses of all sections, as well as the start address, by adding incr π. 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. That's a real risk bestie, like actually.
--change-section-addresssectionpattern{=,+,-}val,--adjust-section-vmasectionpattern{=,+,-}val β set or change both the VMA address and the LMA address of any section matching sectionpattern π―. If=is used, the section address is set to val. Otherwise, val is added to or subtracted from the section address. See the comments under--change-addressesabove β they still apply, fr. If sectionpattern does not match any sections in the input file, a warning will be issued, unless--no-change-warningsis used.--change-section-lmasectionpattern{=,+,-}val β set or change the LMA address of any sections matching sectionpattern π¦. 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 to val. Otherwise, val is added to or subtracted from the section address. See the comments under --change-addresses above. If sectionpattern does not match any sections in the input file, a warning will be issued, unless --no-change-warnings is used.
--change-section-vmasectionpattern{=,+,-}val β set or change the VMA address of any section matching sectionpattern β¨. 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 to val. Otherwise, val is added to or subtracted from the section address. See the comments under --change-addresses above. If sectionpattern does not match any sections in the input file, a warning will be issued, unless --no-change-warnings is 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. Genuinely, do not do this casually.
--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, so it's already the vibe unless you turn it off.--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 π€«. Silence is golden, I guess.--set-section-flagssectionpattern=flags β set the flags for any sections matching sectionpattern π. The flags argument 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 the contents flag for a section which does not have contents, but it is not meaningful to clear the contents flag of a section which does have contents β just remove the section instead, bestie π
. Not all flags are meaningful for all object file formats. In particular the share flag is only meaningful for COFF format files and not for ELF format files. The ELF x86-64 specific flag large corresponds to SHF_X86_64_LARGE. Slay, architecture-specific details.
--set-section-alignmentsectionpattern=align β set the alignment for any sections matching sectionpattern π¦. align specifies the alignment in bytes and must be a power of two, i.e.1,2,4,8.... Powers of two only, no exceptions, that's the rule π.
Tiny note before we keep rolling, bestie π«Ά β setting a sectionβs alignment does not magically line up its LMA or VMA addresses. If those need to change too, use--change-section-lmaand/or--change-section-vma. Also lowkey warning: changing VMAs can cause problems in fully linked binaries where code expects section contents to be at their old address. π
--add-section sectionname=filenameβ adds a brand-new section called sectionname while copying. Its contents come from filename, and its size is the size of the file. This only works on file formats that support sections with arbitrary names. Note: you may need--set-section-flagsto set the attributes of the newly created section. π--dump-section sectionname=filenameβ drops the contents of section sectionname into filename, overwriting whatever was there before. Itβs the inverse of--add-section. Similar to--only-sectionexcept it does not create a formatted file β it just dumps raw binary data, with no relocations applied. Can be specified more than once. β¨--update-section sectionname=filenameβ replaces the existing contents of section sectionname with the contents of filename. The section size gets adjusted to the file size. Section flags for sectionname stay unchanged. For ELF files the section-to-segment mapping also remains unchanged β something you canβt do with--remove-sectionfollowed by--add-section. Can be specified more than once. π
Rename + update combo note: you can use--rename-sectionand--update-sectiontogether on one command line to both update and rename a section. In that case, pass the original section name to--update-section, and pass the original and new section names to--rename-section. πΈ
--add-symbol name=[section:]value[,flags]β adds a new symbol called name while copying. Can be specified multiple times. If section is given, the symbol is associated with and relative to that section; otherwise itβs anABSsymbol. Specifying an undefined section is a fatal error. Thereβs no check on the value β itβs taken as specified. Symbol flags can be specified, and not all flags are meaningful for all object file formats. By default the symbol is global. The special flag'before=othersym'inserts the new symbol in front of the specified othersym; otherwise the symbol(s) are added at the end of the symbol table in the order they appear. π₯--rename-section oldname=newname[,flags]β renames section oldname to newname, optionally changing the sectionβs flags to flags in the process. Big advantage over using a linker script for the rename: the output stays an object file and does not become a linked executable. Accepts the same set of flags as--set-section-flags. π
This one is especially helpful when the input format is binary, because binary input always creates a section called .data. So if you wanted .rodata containing binary data instead, you could use this exact command line to make it happen:
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 how long section names are handled when processing"COFF"and"PE-COFF"object formats. The default,keep, preserves long section names if any are present in the input file.enableanddisableforcibly enable or disable long section names in the output object; whendisableis in effect, any long section names in the input object get truncated.enableonly emits long section names if any are present in the inputs β mostly the same askeep, but itβs left undefined whetherenablemight force creation of an empty string table in the output file. π¦--change-leading-charβ some object file formats use special characters at the start of symbols; the most common is underscore, which compilers often add before every symbol. This tellsobjcopyto change the leading character of every symbol when converting between object file formats. If both formats use the same leading character, this has no effect. Otherwise it adds a character, removes a character, or changes a character, as appropriate. π«--remove-leading-charβ if the first character of a global symbol is the special symbol leading character used by the object file format, remove that character. The most common symbol leading character is underscore. This removes a leading underscore from all global symbols. Useful if you want to link together objects of different file formats with different conventions for symbol names. 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 length must be evenly divisible by num for the swap to be able to take place. Reversing happens before the interleaving is performed. β
This is typically used for generating ROM images for problematic target systems. 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 these eight bytes: 12345678. π
- With
--reverse-bytes=2for the above example, the bytes in the output file would be ordered21436587. - With
--reverse-bytes=4for the above example, the bytes in the output file would be ordered43218765. - Using
--reverse-bytes=2for the above example, followed by--reverse-bytes=4on the output file, the bytes in the second output file would be ordered34127856. --srec-len=ivalβ only meaningful 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β only meaningful for srec output. Avoids generation of S1/S2 records, creating S3-only record format. π--redefine-sym old=newβ changes the name of symbol old to new. Useful when youβre trying to link two things together, have no source, and there are name collisions. π«Ά--redefine-syms=filenameβ applies--redefine-symto each symbol pair"old new"listed in filename. filename is a flat file with one symbol pair per line. Line comments may be introduced by the hash character. May be given more than once. π--weakenβ changes all global symbols in the file to be weak. Useful when building an object that will be linked against other objects using the-Roption to the linker. Only effective when using an object file format that supports weak symbols. π--keep-symbols=filenameβ applies--keep-symbolto each symbol listed in filename. filename is a flat file with one symbol name per line. Line comments may be introduced by the hash character. May be given more than once. πΈ--strip-symbols=filenameβ applies--strip-symbolto each symbol listed in filename. filename is a flat file with one symbol name per line. Line comments may be introduced by the hash character. May be given more than once. π--strip-unneeded-symbols=filenameβ applies--strip-unneeded-symbolto each symbol listed in filename. filename is a flat file with one symbol name per line. Line comments may be introduced by the hash character. May be given more than once. π--keep-global-symbols=filenameβ applies--keep-global-symbolto each symbol listed in filename. filename is a flat file with one symbol name per line. Line comments may be introduced by the hash character. May be given more than once. π¦--localize-symbols=filenameβ applies--localize-symbolto each symbol listed in filename. filename is a flat file with one symbol name per line. Line comments may be introduced by the hash character. May be given more than once. π--globalize-symbols=filenameβ applies--globalize-symbolto each symbol listed in filename. filename is a flat file with one symbol name per line. Line comments may be introduced by the hash character. May be given more than once. Note: this option cannot be used in conjunction with the-Gor--keep-global-symboloptions. π¨--weaken-symbols=filenameβ applies--weaken-symbolto each symbol listed in filename. filename is a flat file with one symbol name per line. Line comments may be introduced by the hash character. 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. Useful when a machine gets 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, 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. Not meaningful for all object file formats. β--readonly-textβ makes the output text write protected. Not meaningful for all object file formats. π--pureβ flags your output file as demand paged β¨. Warning though bestie: this one isn't meaningful for all object file formats, so don't come for me if it does nothing on yours π--impureβ marks the output file as impure π«Ά. Same deal, same disclaimer: not meaningful for every object file format out there.--prefix-symbols=*string*β every single symbol in the output file gets string slapped on the front of it π like a little name tag. All of them. No cap.--prefix-sections=*string*β same energy but for sections: all section names in the output file start with string π--prefix-alloc-sections=*string*β extra specific icon behaviour: only the names of all the allocated sections in the output file get the string prefix πΈ--add-gnu-debuglink=*path-to-file*β builds a.gnu_debuglinksection that holds a reference to path-to-file, then adds it to the output file. Obsessed with this one for real. π
Heads up though: the file at path-to-file must exist. And part of the whole process of adding that .gnu_debuglink section involves embedding a checksum of the contents of the debug info file into the section π so it's not just a string, it's a whole vibe.
So like β if your debug info file is built in one location but it's gonna get installed later into a different location, do not use the path to the installed location π The --add-gnu-debuglink option will fail, because the installed file doesn't exist yet, duh. Instead, put the debug info file in the current directory and use the --add-gnu-debuglink option without any directory components, like this:
objcopy --add-gnu-debuglink=foo.debug
At debug time, the debugger will attempt to look for the separate debug info file in a set of known locations. The exact set varies depending on the distribution being used, 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 these locations before the debugger is run, everything should work correctly β¨ periodt.
--keep-section-symbolsβ when you're stripping a file, maybe with--strip-debugor--strip-unneeded, this one retains any symbols specifying section names, which would otherwise get stripped π€ protective queen behaviour.--keep-file-symbolsβ same but different: when stripping a file, perhaps with--strip-debugor--strip-unneeded, retain any symbols specifying source file names, which would otherwise get stripped π₯Ί we keep the file-name symbols safe.--only-keep-debugβ strips a file, removing contents of any sections that wouldn't be stripped by--strip-debug, and leaving 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. The headers stay 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, honestly.
The intention is that this option gets used in conjunction with --add-gnu-debuglink to create a two part executable. One: a stripped binary that takes up less space in RAM and in a distribution. Two: a debugging information file which is only needed if debugging abilities are required. The suggested procedure to create these files is as follows:
- Link the executable as normal. Assuming that it is 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 π€·ββοΈ Also the --only-keep-debug step is optional. You could instead do this:
- Link the executable as normal.
- Copy "foo" to "foo.full".
- Run
objcopy --strip-debug foo. - Run
objcopy --add-gnu-debuglink=foo.full foo.
i.e., the file pointed to by the --add-gnu-debuglink can be the full executable. It does not have to be a file created by the --only-keep-debug switch π« flexible!
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 like... one file, one link. That's the rule.
--strip-dwoβ removes the contents of all DWARF.dwosections, leaving the remaining debugging sections and all symbols intact π§ This one's intended for use by the compiler as part of the-gsplit-dwarfoption, which splits debug information between the.ofile and a separate.dwofile. The compiler generates all debug information in the same file, then uses the--extract-dwooption to copy the.dwosections to the.dwofile, then the--strip-dwooption to remove those sections from the original.ofile. Cleanup crew energy π--extract-dwoβ extracts the contents of all DWARF.dwosections π See the--strip-dwooption for more info, they're a matching set bestie.--file-alignmentnum β specifies the file alignment. Sections in the file will always begin at file offsets which are multiples of this number. Defaults to512β¨ [This option is specific to PE targets.] π―--heapreserve--heapreserve,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-basevalue β uses value as the base address of your program or dll π This is the lowest memory location that will be used when your program or dll is loaded. To reduce the need to relocate and improve performance of your dlls, each should have a unique base address and not overlap any other dlls π€ no sharing. The default is0x400000for executables, and0x10000000for dlls. [This option is specific to PE targets.]--section-alignmentnum β [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 which 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 have not 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 will then be up to the user to decide if the LMA and VMA need updating. That's you, bestie. You decide. π«΅
--stackreserve--stackreserve,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.] π―--subsystemwhich--subsystemwhich:major--subsystemwhich:major.minor β specifies the subsystem under which your program will execute π₯ The legal values for which arenative,windows,console,posix,efi-app,efi-bsd,efi-rtd,sal-rtd, andxbox. You may optionally set the subsystem version also. 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, this option:- Removes the contents of all sections. π
- Sets the size of every section to zero.
- 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. Efficiency queen.
--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 π ββοΈ we don't do that here.--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 options control how DWARF debug sections are compressed π--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 π¬ and the debug sections get 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 π we put it back, bestie.--elf-stt-common=yes--elf-stt-common=noβ for ELF files, these options control whether common symbols should be converted to theSTT_COMMONorSTT_OBJECTtype π--elf-stt-common=yesconverts common symbol type toSTT_COMMON. π--elf-stt-common=noconverts common symbol type toSTT_OBJECT. β¨
--merge-notes--no-merge-notesβ for ELF files, attempt (or do not attempt) to reduce the size of anySHT_NOTEtype sections by removing duplicate notes π§Ή dedupe slay.-V,--versionβ shows the version number ofobjcopyπ--verilog-data-width=*bytes*β for Verilog output, this option controls the number of bytes converted for each output data element π The input target controls the endianness of the conversion.-v,--verboseβ verbose output: list all object files modified ποΈ In the case of archives,objcopy -Vlists all members of the archive π (yes, that's a-Vin there, copy it exactly, don't @ me).--helpβ shows a summary of the options toobjcopyπ«Ά--infoβ displays a list showing all architectures and object formats available π the full menu, iykyk.@file β reads command-line options from file π The options read are inserted in place of the original@file option. If file does not exist, or cannot be read, then the option will be treated literally, and not removed β so it just stays there awkwardly π
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 π it's files all the way down, bestie.
β¨ SEE ALSO β¨
okay so you're done here but the β¨loreβ¨ continues, bestie:
ld(1)β the linker, aka the one who actually puts everything together πobjdump(1)β the nosy bestie who reads object files back to you, iconic behavior ngl π- and the Info entries for
binutilsβ the deep lore, the director's cut, the whole extended universe πβ¨
π COPYRIGHT π
Okay so legal time, but make it cute π«Ά β here's the deal, word for word:
Copyright (c) 1991-2026 Free Software Foundation, Inc.
Permission is granted 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, no Front-Cover Texts, and no Back-Cover Texts. π
A copy of the license is included in the section entitled "GNU Free Documentation License" β so like, it's literally right there in the doc if you wanna read it, no cap πβ¨
and that's the whole page, bestie!! you made it to the end, so proud of you ππ this lil masterpiece is from binutils-2.47 and it's dated 2026-08-26 β go forth and objcopy your heart out, the object files could never π
ππ¦
π¦ where this page comes from
- arch rolling: loongarch64-linux-gnu-binutils 2.47-1 Β· GPL-2.0-or-later AND GPL-3.0-or-later AND LGPL-2.0-or-later AND LGPL-3.0-or-later AND GFDL-1.3-or-later AND FSFAP
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms