usr.bin/ar/ar.5

   1 .\" Copyright (c) 1990, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by the University of
  15 .\"     California, Berkeley and its contributors.
  16 .\" 4. Neither the name of the University nor the names of its contributors
  17 .\"    may be used to endorse or promote products derived from this software
  18 .\"    without specific prior written permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .\"     @(#)ar.5.5      8.1 (Berkeley) 6/9/93
  33 .\" $FreeBSD: src/usr.bin/ar/ar.5,v 1.5.2.2 2001/12/14 15:53:29 ru Exp $
  34 .\" $DragonFly: src/usr.bin/ar/Attic/ar.5,v 1.3 2006/02/17 19:38:54 swildner Exp $
  35 .\"
  36 .Dd June 9, 1993
  37 .Dt AR 5
  38 .Os
  39 .Sh NAME
  40 .Nm ar
  41 .Nd archive (library) file format
  42 .Sh SYNOPSIS
  43 .In ar.h
  44 .Sh DESCRIPTION
  45 The archive command
  46 .Nm
  47 combines several files into one.
  48 Archives are mainly used as libraries of object files intended to be
  49 loaded using the link-editor
  50 .Xr ld 1 .
  51 .Pp
  52 A file created with
  53 .Nm
  54 begins with the ``magic'' string "!<arch>\en".
  55 The rest of the archive is made up of objects, each of which is composed
  56 of a header for a file, a possible file name, and the file contents.
  57 The header is portable between machine architectures, and, if the file
  58 contents are printable, the archive is itself printable.
  59 .Pp
  60 The header is made up of six variable length
  61 .Tn ASCII
  62 fields, followed by a
  63 two character trailer.
  64 The fields are the object name (16 characters), the file last modification
  65 time (12 characters), the user and group id's (each 6 characters), the file
  66 mode (8 characters) and the file size (10 characters).
  67 All numeric fields are in decimal, except for the file mode which is in
  68 octal.
  69 .Pp
  70 The modification time is the file
  71 .Fa st_mtime
  72 field, i.e.,
  73 .Dv CUT
  74 seconds since
  75 the epoch.
  76 The user and group id's are the file
  77 .Fa st_uid
  78 and
  79 .Fa st_gid
  80 fields.
  81 The file mode is the file
  82 .Fa st_mode
  83 field.
  84 The file size is the file
  85 .Fa st_size
  86 field.
  87 The two-byte trailer is the string "\`\en".
  88 .Pp
  89 Only the name field has any provision for overflow.
  90 If any file name is more than 16 characters in length or contains an
  91 embedded space, the string "#1/" followed by the
  92 .Tn ASCII
  93 length of the
  94 name is written in the name field.
  95 The file size (stored in the archive header) is incremented by the length
  96 of the name.
  97 The name is then written immediately following the archive header.
  98 .Pp
  99 Any unused characters in any of these fields are written as space
 100 characters.
 101 If any fields are their particular maximum number of characters in
 102 length, there will be no separation between the fields.
 103 .Pp
 104 Objects in the archive are always an even number of bytes long; files
 105 which are an odd number of bytes long are padded with a newline (``\en'')
 106 character, although the size in the header does not reflect this.
 107 .Sh COMPATIBILITY
 108 No archive format is currently specified by any standard.
 109 .At V
 110 has historically distributed archives in a different format from
 111 all of the above.
 112 .Sh SEE ALSO
 113 .Xr ar 1 ,
 114 .Xr stat 2
 115 .Sh HISTORY
 116 There have been at least four
 117 .Nm
 118 formats.
 119 The first was denoted by the leading ``magic'' number 0177555 (stored as
 120 type int).
 121 These archives were almost certainly created on a 16-bit machine, and
 122 contain headers made up of five fields.
 123 The fields are the object name (8 characters), the file last modification
 124 time (type long), the user id (type char), the file mode (type char) and
 125 the file size (type unsigned int).
 126 Files were padded to an even number of bytes.
 127 .Pp
 128 The second was denoted by the leading ``magic'' number 0177545 (stored as
 129 type int).
 130 These archives may have been created on either 16 or 32-bit machines, and
 131 contain headers made up of six fields.
 132 The fields are the object name (14 characters), the file last modification
 133 time (type long), the user and group id's (each type char), the file mode
 134 (type int) and the file size (type long).
 135 Files were padded to an even number of bytes.
 136 .\" For more information on converting from this format see
 137 .\" .Xr arcv 8 .
 138 .Pp
 139 The current archive format (without support for long character names and
 140 names with embedded spaces) was introduced in
 141 .Bx 4.0 .
 142 The headers were the same as the current format, with the exception that
 143 names longer than 16 characters were truncated, and names with embedded
 144 spaces (and often trailing spaces) were not supported.
 145 It has been extended for these reasons,
 146 as described above.
 147 This format first appeared in
 148 .Bx 4.4 .