Annotation of src/usr.bin/ranlib/ranlib.5, Revision 1.4
1.4 ! aaron 1: .\" $OpenBSD: ranlib.5,v 1.3 1998/09/27 16:57:50 aaron Exp $
! 2: .\"
1.1 deraadt 3: .\" Copyright (c) 1990, 1991 The Regents of the University of California.
4: .\" 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 5.2 (Berkeley) 5/10/91
35: .\"
36: .Dd May 10, 1991
37: .Dt RANLIB 5
38: .Os
39: .Sh NAME
40: .Nm ranlib
41: .Nd archive (library) table-of-contents format
42: .Sh SYNOPSIS
43: .Fd #include <ranlib.h>
44: .Sh DESCRIPTION
45: The archive table-of-contents command
46: .Nm ranlib
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
1.3 aaron 54: .Nm ranlib
1.1 deraadt 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
1.4 ! aaron 58: field,
! 59: .Dq __.SYMDEF .
1.1 deraadt 60: .Pp
1.4 ! aaron 61: The second part is a
! 62: .Li long
! 63: followed by a list of ranlib structures.
1.1 deraadt 64: The long is the size, in bytes, of the list of ranlib structures.
65: Each of the ranlib structures consists of a zero based offset into the
66: next section (a string table of symbols) and an offset from the beginning
67: of the archive to the start of the archive file which defines the symbol.
68: The actual number of ranlib structures is this number divided by the size
69: of an individual ranlib structure.
70: .Pp
1.4 ! aaron 71: The third part is a
! 72: .Li long
! 73: followed by a string table.
1.1 deraadt 74: The long is the size, in bytes of the string table.
75: .Sh SEE ALSO
76: .Xr ar 1 ,
77: .Xr ranlib 1