1.\" $NetBSD: ranlib.5,v 1.3 2002/02/13 08:18:16 ross 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. All advertising materials mentioning features or use of this software 15.\" must display the following acknowledgement: 16.\" This product includes software developed by the University of 17.\" California, Berkeley and its contributors. 18.\" 4. Neither the name of the University nor the names of its contributors 19.\" may be used to endorse or promote products derived from this software 20.\" without specific prior written permission. 21.\" 22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND 23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 25.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE 26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 32.\" SUCH DAMAGE. 33.\" 34.\" from: @(#)ranlib.5.5 8.1 (Berkeley) 6/6/93 35.\" 36.Dd June 6, 1993 37.Dt RANLIB 5 38.Os 39.Sh NAME 40.Nm ranlib 41.Nd a.out archive (library) table-of-contents format 42.Sh SYNOPSIS 43.Fd #include \*[Lt]ranlib.h\*[Gt] 44.Sh DESCRIPTION 45The archive table-of-contents command 46.Nm 47creates a table of contents for archives, containing object files, to 48be used by the link-editor 49.Xr ld 1 . 50It operates on archives created with the utility 51.Xr ar 1 . 52.Pp 53The 54.Nm 55function 56prepends a new file to the archive which has three separate parts. 57The first part is a standard archive header, which has a special name 58field, "__.SYMDEF". 59.Pp 60The second part is a 61.Dq long 62followed by a list of ranlib structures. 63The long is the size, in bytes, of the list of ranlib structures. 64Each of the ranlib structures consists of a zero based offset into the 65next section (a string table of symbols) and an offset from the beginning 66of the archive to the start of the archive file which defines the symbol. 67The actual number of ranlib structures is this number divided by the size 68of an individual ranlib structure. 69.Pp 70The third part is a 71.Dq long 72followed by a string table. 73The long is the size, in bytes of the string table. 74.Sh SEE ALSO 75.Xr ar 1 , 76.Xr ranlib 1 77.Sh BUGS 78The 79.Tn \*[Lt]ranlib.h\*[Gt] 80header file, and the 81.Xr ranlib 5 82manual page, do not describe the table-of-contents used by ELF systems, which 83is that from the 84.At V.4 85ABI. 86