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