share/man/man5/ar.5

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