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\(em\&generate index to archive.
  12
  13 .SH SYNOPSIS
  14 .hy 0
  15 .na
  16 .B ranlib \c
  17 .I archive\c
  18 \&
  19 .ad b
  20 .hy 1
  21 .SH DESCRIPTION
  22 \c
  23 .B ranlib\c
  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
  28 You may use `\|\c
  29 .B nm \-s\c
  30 \|' or `\|\c
  31 .B nm +print-armap\c
  32 \|' to list this index.
  33
  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
  38 The GNU \c
  39 .B ranlib\c
  40 \& program is another form of GNU \c
  41 .B ar\c
  42 \&; running
  43 \c
  44 .B ranlib\c
  45 \& is completely equivalent to executing `\|\c
  46 .B ar \-s\c
  47 \|'.
  48
  49
  50 .SH "SEE ALSO"
  51 .RB "`\|" binutils "\|'"
  52 entry in
  53 .B
  54 info\c
  55 \&;
  56 .I
  57 The GNU Binary Utilities\c
  58 \&, Roland H. Pesch (October 1991);
  59 .BR ar "(" 1 "),"
  60 .BR nm "(" 1 ")."
  61
  62
  63 .SH COPYING
  64 Copyright (c) 1991 Free Software Foundation, Inc.
  65 .PP
  66 Permission is granted to make and distribute verbatim copies of
  67 this manual provided the copyright notice and this permission notice
  68 are preserved on all copies.
  69 .PP
  70 Permission is granted to copy and distribute modified versions of this
  71 manual under the conditions for verbatim copying, provided that the
  72 entire resulting derived work is distributed under the terms of a
  73 permission notice identical to this one.
  74 .PP
  75 Permission is granted to copy and distribute translations of this
  76 manual into another language, under the above conditions for modified
  77 versions, except that this permission notice may be included in
  78 translations approved by the Free Software Foundation instead of in
  79 the original English.