| ar | |
|---|---|
| Original authors | Ken Thompson, Dennis Ritchie (AT&T Bell Laboratories) |
| Developers | Variousopen-source andcommercial developers |
| Initial release | November 3, 1971; 54 years ago (1971-11-03) |
| Written in | C |
| Operating system | Unix,Unix-like,V,Plan 9,Inferno |
| Platform | Cross-platform |
| Type | Command |
| License | Plan 9:MIT License |
| archiver format | |
|---|---|
| Filename extension | |
| Internet media type | application/x-archive[1] |
| Magic number | !<arch> |
| Type of format | archive format |
| Container for | usuallyobject files (.o) |
| Standard | Not standardized, several variants exist |
| Open format? | Yes[2] |
ar, short forarchiver, is ashellcommand for maintaining multiplefiles as a singlearchive file (i.e. afile archiver).It is often used to create and updatestatic library files that the link editor orlinker uses and for generatingdeb format packages for theDebianLinux distribution. It can be used to create archives for any purpose, but has been largely replaced bytar for purposes other than static libraries.[3]
Originally developed forUnix, the command is widely available on Unix-based systems, and similar commands are available on other platforms.An implementation is included inGNU Binutils.[2]

The format of a file that results from usingar has never been standardized.[4][5]
The first format appeared in the first edition of Unix[6] and was used throughVersion 6 Unix.[7][4]Version 7 Unix had a modified version of that format,[8][4] which was also used inUNIX System III[9] and inUNIX System V on thePDP-11.[10]
A new format was introduced in the first release of System V on processors other than PDP-11s.[11]
Modern archives are, on most systems, based on a common format with two main variants,BSD[4] (initially used fora.out files) and UNIX System V release 2 and later[12] (initially used forCOFF files and later used forELF files) and used as well byGNU[13] andWindows. AIX has its own formats (small[14] and big[15]), as does Coherent; those formats vary significantly from the common format.
An archive file begins with aheader that identifies the file type and is followed with a section for each contained file. Each contained file section consists of a header followed by the file content. The headers consist solely of printable ASCII characters and line feeds. In fact, an archive containing only text files is also a text file.
The content of a contained file begins on an even byte boundary. Anewline is inserted between files as padding, if necessary. Nevertheless, the size stored reflects the size excluding padding.[16]
The first header, a.k.a. file signature, is amagic number that encodes the ASCII string!<arch> followed by a singleline feed character (0x0A).
Each file is preceded by a header that containsinformation about the file. The common format is as follows. Numeric values are encoded in ASCII and all values are right-padded with spaces (0x20).
| Offset | Length | Content | Format |
|---|---|---|---|
| 0 | 16 | File identifier | ASCII |
| 16 | 12 | File modification timestamp (in seconds) | Decimal |
| 28 | 6 | Owner ID | Decimal |
| 34 | 6 | Group ID | Decimal |
| 40 | 8 | File mode (type and permission) | Octal |
| 48 | 10 | File size in bytes | Decimal |
| 58 | 2 | Ending characters | 0x60 0x0A |
Variants of the command were developed to address issues including:
-s option for updating it. Most implementations put it at the first file entry.[17]The BSD implementation stores file names right-padded with ASCII spaces. This causes issues with spaces inside file names.[clarification needed] The4.4BSD implementation stores extended file names[clarification needed] by placing the string "#1/" followed by the file name length in the file name field, and storing the real file name in front of the data section.[4]
TheBSD implementation traditionally does not handle the building of a global symbol lookup table, and delegates this task to a separate utility,ranlib,[18] which inserts an architecture-specific[clarification needed] file named__.SYMDEF as first archive member.[19] Some descendants put a space and "SORTED" after the name to indicate a sorted version.[20] A 64-bit variant called__.SYMDEF_64 exists onDarwin.
To conform to POSIX, newer BSD implementations support the-s option instead ofranlib. FreeBSD in particular ditched the SYMDEF table format and embraced the System V style table.[21]
To allow spaces in file names, the System V implementation uses a slash ('/') to mark the end of the file. This limits the file name to 15 chars. Filenames longer than 15 ASCII chars are replaced by an index, represented by a slash ('/') followed by the decimal character offset in the indexfile of the start or the name. The index file is named "//" and is usually the second entry of the archive, after the symbol table which always is the first. The format of this "//" file itself is simply a list of the long file names, separated by one or more LF characters. LF characters cannot be part of a filename. The GNU version uses '/'-terminated names and no LF.
The System V implementation uses the special file name "/" to denote that the following data entry contains a symbol lookup table, which is used in ar libraries[clarification needed] to speed up access. This symbol table is built in three parts which are recorded together as contiguous data.
Some System V systems do not use this format.For operating systems such asHP-UX 11.0, this information is stored in a data structure based on theSOM file format.
The special file "/" is not terminated with a specific sequence; the end is assumed once the last symbol name has been read.[clarification needed]
To overcome the 4 GiB file size limit[clarification needed] some operating system likeSolaris 11.2 and GNU use a variant lookup table. Instead of 32-bit integers, 64-bit integers are used in the symbol lookup tables. The string "/SYM64/" instead "/" is used as identifier for this table[22]
TheWindows (PE/COFF) variant is based on the SysV/GNU variant. The first entry "/" has the same layout as the SysV/GNU symbol table. The second entry is another "/", a Microsoft extension that stores an extended symbol cross-reference table. This one is sorted and uses little-endian integers.[5][23] The third entry is the optional "//" long name data as in SysV/GNU.[24]
TheGNU binutils andElfutils implementations have an additional "thin archive" format with the magic number!<thin>. A thin archive only contains a symbol table and references to the file. The file format is essentially a System V format archive where every file is stored without the data sections. Every file name is stored as a "long" file name and they are to be resolved as if they weresymbolic links.[25]
The following command creates an archivelibclass.a withobject filesclass1.o,class2.o,class3.o:
ar rcs libclass.a class1.o class2.o class3.o
The linkerld can read object code from an archive file. The following example shows how the archivelibclass.a (specified as-lclass) is linked with the object code ofmain.o.
ld main.o -lclass
ar – Shell and Utilities Reference,The Single UNIX Specification, Version 5 fromThe Open Groupar(5) – FreeBSD File FormatsManualar: create and maintain library archives – Shell and Utilities Reference,The Single UNIX Specification, Version 5 fromThe Open Groupar(1) – Plan 9 Programmer's Manual, Volume 1ar(1) – Inferno General commandsManualar(1) – Linux User CommandsManualar(1) – FreeBSD General CommandsManualar(1) – Version 7 Unix Programmer'sManualar(5) – FreeBSD File FormatsManual—an account of Unix formats