This commit was manufactured by cvs2svn to create branch 'binutils-
[external/binutils.git] / binutils / ranlib.1
1 .\" Copyright (c) 1991 Free Software Foundation
2 .\" See section COPYING for conditions for redistribution
3 .TH ranlib 1 "5 November 1991" "cygnus support" "GNU Development Tools"
4 .de BP
5 .sp
6 .ti \-.2i
7 \(**
8 ..
9
10 .SH NAME
11 ranlib \- generate index to archive.
12
13 .SH SYNOPSIS
14 .hy 0
15 .na
16 .B ranlib \c
17 .RB "[\|" \-v | \-V "\|]"
18 .I archive\c
19 \&
20 .ad b
21 .hy 1
22 .SH DESCRIPTION
23 .B ranlib
24 generates an index to the contents of an archive, and
25 stores it in the archive.  The index lists each symbol defined by a
26 member of an archive that is a relocatable object file.  
27 .PP
28 You may use
29 .RB ` "nm \-s" '
30 or
31 .RB ` "nm \-\-print-armap" '
32 to list this index.
33 .PP
34 An archive with such an index speeds up linking to the library, and
35 allows routines in the library to call each other without regard to
36 their placement in the archive.
37 .PP
38 The GNU
39 .B ranlib
40 program is another form of GNU
41 .BR ar ;
42 running
43 .B ranlib
44 is completely equivalent to executing
45 .RB ` "ar \-s" '.
46
47 .SH OPTIONS
48 .TP
49 .B \-v
50 Print the version number of
51 .B ranlib
52 and exit.
53
54 .SH "SEE ALSO"
55 .RB "`\|" binutils "\|'"
56 entry in 
57 .B
58 info\c
59 \&; 
60 .I
61 The GNU Binary Utilities\c
62 \&, Roland H. Pesch (October 1991); 
63 .BR ar "(" 1 "),"
64 .BR nm "(" 1 ")."
65
66
67 .SH COPYING
68 Copyright (c) 1991 Free Software Foundation, Inc.
69 .PP
70 Permission is granted to make and distribute verbatim copies of
71 this manual provided the copyright notice and this permission notice
72 are preserved on all copies.
73 .PP
74 Permission is granted to copy and distribute modified versions of this
75 manual under the conditions for verbatim copying, provided that the
76 entire resulting derived work is distributed under the terms of a
77 permission notice identical to this one.
78 .PP
79 Permission is granted to copy and distribute translations of this
80 manual into another language, under the above conditions for modified
81 versions, except that this permission notice may be included in
82 translations approved by the Free Software Foundation instead of in
83 the original English.