AR(1)
π NAME π
ar β create, modify, and extract from archives. This is ar from GNU Development Tools, aka the archive queen, and she is literally here to make your library era iconic π
β¨ SYNOPSIS β¨
ar [-X32_64]
[-]p[mod]
[--plugin name]
[--target bfdname]
[--output dirname]
[--record-libdeps libdeps]
[--thin]
[relpos] [count] archive [member...] ar -M [< mri-script]
π¦ DESCRIPTION π¦
Okay so the GNU ar program creates, modifies, and extracts from archives. An archive is a single file holding a collection of other files in a structure that makes it possible to retrieve the original individual files β those are called members of the archive. cute concept, honestly π
The original files' contents, mode (permissions), timestamp, owner, and group are preserved in the archive, and can be restored on extraction. yes bestie, she keeps the whole vibe intact β¨
GNU ar can maintain archives whose members have names of any length; however, depending on how ar is configured on your system, a limit on member-name length may be imposed for compatibility with archive formats maintained with other tools. If it exists, the limit is often 15 characters (typical of formats related to a.out) or 16 characters (typical of formats related to coff). so yeah, sometimes there is a name-length situation, lowkey tragic but real π
ar is considered a binary utility because archives of this sort are most often used as libraries holding commonly needed subroutines. Since libraries often will depend on other libraries, ar can also record the dependencies of a library when the --record-libdeps option is specified. she's not just organizing files, she's keeping the dependency lore π«Ά
ar creates an index to the symbols defined in relocatable object modules in the archive when you specify the modifier s. Once created, this index is updated in the archive whenever ar makes a change to its contents (save for the q update operation). An archive with such an index speeds up linking to the library. that's the good stuff right there π₯
You may use nm -s or nm --print-armap to list this index table. If an archive lacks the table, another form of ar called ranlib can be used to add just the table. she has a whole little sibling for that one job, iconic π
GNU ar can optionally create a thin archive, which contains a symbol index and references to the original copies of the member files of the archive. This is useful for building libraries for use within a local build tree, where the relocatable objects are expected to remain available, and copying the contents of each object would only waste time and space. efficiency slay β¨
An archive can either be thin or it can be normal. It cannot be both at the same time. Once an archive is created its format cannot be changed without first deleting it and then creating a new archive in its place.
β οΈ bestie, that format-lock is serious: no little in-place glow-up from thin to normal or normal to thin. delete and recreate, or leave it alone.
Thin archives are also flattened, so that adding one thin archive to another thin archive does not nest it, as would happen with a normal archive. Instead the elements of the first archive are added individually to the second archive. no nesting drama, just flat and cute π¦
The paths to the elements of the archive are stored relative to the archive itself. noted, bestie πΈ
GNU ar is designed to be compatible with two different facilities. You can control its activity using command-line options, like the different varieties of ar on Unix systems; or, if you specify the single command-line option -M, you can control it with a script supplied via standard input, like the MRI "librarian" program. two modes, both valid, main character energy π
π OPTIONS π
GNU ar allows you to mix the operation code p and modifier flags mod in any order, within the first command-line argument.
If you wish, you may begin the first command-line argument with a dash.
The p keyletter specifies what operation to execute; it may be any of the following, but you must specify only one of them:
dβ Delete modules from the archive. Specify the names of modules to be deleted asmember...; the archive is untouched if you specify no files to delete. If you specify thevmodifier,arlists each module as it is deleted. bye-bye, members πmβ Use this operation to move members in an archive. The ordering of members in an archive can make a difference in how programs are linked using the library, if a symbol is defined in more than one member. If no modifiers are used withm, any members you name in thememberarguments are moved to the end of the archive; you can use thea,b, orimodifiers to move them to a specified place instead. rearrange her little archive shelves π§pβ Print the specified members of the archive, to the standard output file. If thevmodifier is specified, show the member name before copying its contents to standard output. If you specify nomemberarguments, all the files in the archive are printed. spill the archive contents, literally πqβ Quick append; Historically, add the filesmember...to the end ofarchive, without checking for replacement. The modifiersa,b, andido not affect this operation; new members are always placed at the end of the archive. The modifiervmakesarlist each file as it is appended. Since the point of this operation is speed, implementations ofarhave the option of not updating the archive's symbol table if one exists. Too many different systems however assume that symbol tables are always up-to-date, so GNUarwill rebuild the table even with a quick append. Note β GNUartreats the commandqsas a synonym forrβ replacing already existing files in the archive and appending new ones at the end. fast append, but GNUarstill keeps the table current, no cap π₯rβ Insert the filesmember...intoarchive(with replacement). This operation differs fromqin that any previously existing members are deleted if their names match those being added. If one of the files named inmember...does not exist,ardisplays an error message, and leaves undisturbed any existing members of the archive matching that name. By default, new members are added at the end of the file; but you may use one of the modifiersa,b, orito request placement relative to some existing member. The modifiervused with this operation elicits a line of output for each file inserted, along with one of the lettersaorrto indicate whether the file was appended (no old member deleted) or replaced. replacement era, but with receipts π«Άsβ Add an index to the archive, or update it if it already exists. Note this command is an exception to the rule that there can only be one command letter, as it is possible to use it as either a command or a modifier. In either case it does the same thing. she's flexible like that, and still on brand β¨tβ Display a table listing the contents ofarchive, or those of the files listed inmember...that are present in the archive. Normally only the member name is shown, but if the modifierOis specified, then the corresponding offset of the member is also displayed. Finally, in order to see the modes (permissions), timestamp, owner, group, and size thevmodifier should be included. If you do not specify amember, all files in the archive are listed. If there is more than one file with the same name (say,fie) in an archive (sayb.a),ar t b.a fielists only the first instance; to see them all, you must ask for a complete listing β in our example,ar t b.a. peek at the archive menu, bestie πxβ Extract members (namedmember) from the archive. You can use thevmodifier with this operation, to request thatarlist each name as it extracts it. If you do not specify amember, all files in the archive are extracted. Files cannot be extracted from a thin archive, and there are restrictions on extracting from archives created withP: The paths must not be absolute, may not contain.., and any subdirectories in the paths must exist. If it is desired to avoid these restrictions then use the--outputoption to specify an output directory. extraction time, but read the thin-archive andP-archive fine print first π
A number of modifiers (mod) may immediately follow the p keyletter, to specify variations on an operation's behavior:
aβ Add new files after an existing member of the archive. If you use the modifiera, the name of an existing archive member must be present as therelposargument, before thearchivespecification. after this member, periodt πbβ Add new files before an existing member of the archive. If you use the modifierb, the name of an existing archive member must be present as therelposargument, before thearchivespecification. (same asi). before this member, cute and clear πcβ Create the archive. The specifiedarchiveis always created if it did not exist, when you request an update. But a warning is issued unless you specify in advance that you expect to create it, by using this modifier. she's like βbestie, say you meant to make a new archiveβ βDβ Operate in deterministic mode. When adding files and the archive index use zero for UIDs, GIDs, timestamps, and use consistent file modes for all files. When this option is used, ifaris used with identical options and identical input files, multiple runs will create identical output files regardless of the input files' owners, groups, file modes, or modification times. Ifbinutilswas configured with--enable-deterministic-archives, then this mode is on by default. It can be disabled with theUmodifier, below. deterministic queen, reproducible output, obsessed πfβ Truncate names in the archive. GNUarwill normally permit file names of any length. This will cause it to create archives which are not compatible with the nativearprogram on some systems. If this is a concern, thefmodifier may be used to truncate file names when putting them in the archive. short names for compatibility, but only if you need it π¦iβ Insert new files before an existing member of the archive. If you use the modifieri, the name of an existing archive member must be present as therelposargument, before thearchivespecification. (same asb). insert before, literally same energy πlβ Specify dependencies of this library. The dependencies must immediately follow this option character, must use the same syntax as the linker command line, and must be specified within a single argument. I.e., if multiple items are needed, they must be quoted to form a single command line argument. For examplel "-L/usr/local/lib -lmydep1 -lmydep2". dependency lore, all in one argument π«ΆNβ Uses thecountparameter. This is used if there are multiple entries in the archive with the same name. Extract or delete instancecountof the given name from the archive. when there are duplicates,countis the girlies' tiebreaker πoβ Preserve the original dates of members when extracting them. If you do not specify this modifier, files extracted from the archive are stamped with the time of extraction. keep the original timestamp or get the extraction timestamp, your call β°Oβ Display member offsets inside the archive. Use together with thetoption. offset reveal, but only withtπPβ Use the full path name when matching or storing names in the archive. Archives created with full path names are not POSIX compliant, and thus may not work with tools other than up to date GNU tools. Modifying such archives with GNUarwithout usingPwill remove the full path names unless the archive is a thin archive. Note thatPmay be useful when adding files to a thin archive sincerwithoutPignores the path when choosing which element to replace. Thus
ar rcST archive.a subdir/file1 subdir/file2 file1
...will result in that first subdir/file1 getting replaced by file1 from the current directory. Slap a P in there and that replacement does not happen. no cap π
sβ writes an object-file index into the archive, or updates one that's already there β even if literally nothing else about the archive changed. You can use this modifier with any operation, or just all by itself. Runningar son an archive is exactly the same as runningranlibon it. same energy, different outfit β¨Sβ do not generate an archive symbol table. This can speed things up when you're building a big library in several steps, ngl, but it'll negatively impact performance if the resulting archive gets used with the linker. So to actually get a symbol table, you gotta either leaveSoff on the last time you runar, or runranlibon the archive afterwards. π«ΆTβ deprecated alias for--thin. Big disclaimer bestie:Tis not recommended, because in a bunch of otherarimplementationsTmeans something totally different β as specified by X/Open System Interface. messy. πuβ okay so normallyar r... inserts all the files you list. If you only want to insert the ones that are newer than existing members with the same names, use this modifier. Theumodifier is only allowed for ther(replace) operation. In particular,quis not allowed, because checking timestamps would lose the speed advantage you get fromq.
Heads up π β if an archive was created in a deterministic manner, e.g. via theDmodifier, then replacement will always happen and theumodifier is completely ineffective.
Uβ do not operate in deterministic mode. This is the exact inverse of theDmodifier above: added files and the archive index get their actualUID,GID, timestamp, and file mode values. π₯
This is the default, unless binutils was configured with --enable-deterministic-archives.
vβ asks for the verbose version of an operation. Lots of operations print extra info, like the filenames being processed, when you tackvon the end. iconic behavior honestly πVβ shows the version number ofar. that's it. that's the whole modifier. β¨
The ar program also supports some command-line options which are neither modifiers nor actions, but which do change its behaviour in specific ways:
--helpβ displays the list of command-line options supported byar, then dips out. bye π--versionβ displays the version information ofar, then exits. cute and short π-X32_64βarignores an initial option spelled-X32_64, for compatibility with AIX. The behaviour produced by this option is the default for GNUar.ardoes not support any of the other-Xoptions; in particular, it does not support-X32, which is the default for AIXar. so if you came here expecting the other-Xflags... nope π--pluginname β the optional command-line switch--plugin namecausesarto load the plugin called name, which adds support for more file formats, including object files with link-time optimization information. π¦
This option is only available if the toolchain has been built with plugin support enabled.
If --plugin isn't provided, but plugin support has been enabled, then ar iterates over the files in ${libdir}/bfd-plugins in alphabetic order, and the first plugin that claims the object in question gets used. first come, first served bestie β¨
Please note: this plugin search directory is not the one used byld's-pluginoption. In order to makearuse the linker plugin, it must be copied into the${libdir}/bfd-pluginsdirectory. For GCC based compilations the linker plugin is calledliblto_plugin.so.0.0.0. For Clang based compilations it's calledLLVMgold.so. The GCC plugin is always backwards compatible with earlier versions, so it's sufficient to just copy the newest one. π«Ά
--targettarget β the optional command-line switch--target bfdnamespecifies that the archive members are in an object code format different from your system's default format. See
not me leaving this exactly how the page has it π the original sentence just stops at "See" β I'm not out here inventing lore, bestie.
--outputdirname β--outputlets you specify a path to a directory that archive members should be extracted into. If you don't specify this option, the current directory gets used. π
Note β even though this option's presence implies an x extraction operation, you still have to actually include that option on the command line. can't just vibe your way into it, sorry π
--record-libdepslibdeps β--record-libdepsis identical to thelmodifier, just handled in long form. same thing, longer name π--thinβ makes the specified archive a thin archive. If it already exists and is a regular archive, the existing members must be present in the same directory as archive. π@file β read command-line options from file. The options that get read are inserted in place of the original@fileoption. If file doesn't exist, or can't be read, then the option is treated literally, and not removed. π§
Options inside file are separated by whitespace. A whitespace character may be included in an option by wrapping the whole option in either single or double quotes. Any character (including a backslash) may be included by prefixing the character with a backslash. And yes β the file may itself contain additional @file options; any such options get processed recursively. it's giving inception, and we love her β
π SEE ALSO
nm(1), ranlib(1), and the Info entries for binutils. go read 'em, they're literally right there π
π COPYRIGHT
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, 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".
that's the whole page, bestie β¨π this little masterpiece is binutils-2.47, dated 2026-08-31 β go forth and archive responsibly, mwah π«Άπ
π
π¦ where this page comes from
- arch rolling: riscv64-linux-gnu-binutils 2.47-1 Β· GPL-2.0-or-later
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms