xref: /386bsd/usr/src/usr.bin/ranlib/ranlib.5.5 (revision a2142627)
1.\" Copyright (c) 1990, 1991 The Regents of the University of California.
2.\" 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	5.2 (Berkeley) 5/10/91
33.\"
34.Dd May 10, 1991
35.Dt RANLIB 5
36.Os
37.Sh NAME
38.Nm ranlib
39.Nd archive (library) table-of-contents format
40.Sh SYNOPSIS
41.Fd #include <ranlib.h>
42.Sh DESCRIPTION
43The archive table-of-contents command
44.Nm ranlib
45creates a table of contents for archives, containing object files, to
46be used by the link-editor
47.Xr ld 1 .
48It operates on archives created with the utility
49.Xr ar 1 .
50.Pp
51The
52.Nm Ranlib
53function
54prepends a new file to the archive which has three separate parts.
55The first part is a standard archive header, which has a special name
56field,  "__.SYMDEF".
57.Pp
58The second part is a ``long'' followed by a list of ranlib structures.
59The long is the size, in bytes, of the list of ranlib structures.
60Each of the ranlib structures consists of a zero based offset into the
61next section (a string table of symbols) and an offset from the beginning
62of the archive to the start of the archive file which defines the symbol.
63The actual number of ranlib structures is this number divided by the size
64of an individual ranlib structure.
65.Pp
66The third part is a ``long'' followed by a string table.
67The long is the size, in bytes of the string table.
68.Sh SEE ALSO
69.Xr ar 1 ,
70.Xr ranlib 1
71