usr.bin/ranlib/ranlib.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 .\"     @(#)ranlib.5.5  8.1 (Berkeley) 6/6/93
  33 .\" $FreeBSD: src/usr.bin/ranlib/ranlib.5,v 1.4.2.1 2001/12/14 15:53:31 ru Exp $
  34 .\" $DragonFly: src/usr.bin/ranlib/Attic/ranlib.5,v 1.2 2003/06/17 04:29:30 dillon Exp $
  35 .\"
  36 .Dd June 6, 1993
  37 .Dt RANLIB 5
  38 .Os
  39 .Sh NAME
  40 .Nm ranlib
  41 .Nd archive (library) table-of-contents format
  42 .Sh SYNOPSIS
  43 .In ranlib.h
  44 .Sh DESCRIPTION
  45 The archive table-of-contents command
  46 .Nm
  47 creates a table of contents for archives, containing object files, to
  48 be used by the link-editor
  49 .Xr ld 1 .
  50 It operates on archives created with the utility
  51 .Xr ar 1 .
  52 .Pp
  53 The
  54 .Nm
  55 function
  56 prepends a new file to the archive which has three separate parts.
  57 The first part is a standard archive header, which has a special name
  58 field,  "__.SYMDEF".
  59 .Pp
  60 The second part is a ``long'' followed by a list of ranlib structures.
  61 The long is the size, in bytes, of the list of ranlib structures.
  62 Each of the ranlib structures consists of a zero based offset into the
  63 next section (a string table of symbols) and an offset from the beginning
  64 of the archive to the start of the archive file which defines the symbol.
  65 The actual number of ranlib structures is this number divided by the size
  66 of an individual ranlib structure.
  67 .Pp
  68 The third part is a ``long'' followed by a string table.
  69 The long is the size, in bytes of the string table.
  70 .Sh SEE ALSO
  71 .Xr ar 1 ,
  72 .Xr ranlib 1