contrib/binutils/binutils/doc/ranlib.1

   1 .\" Automatically generated by Pod::Man v1.3, Pod::Parser v1.13
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24
  25 .fi
  26 ..
  27 .\" Set up some character translations and predefined strings.  \*(-- will
  28 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  29 .\" double quote, and \*(R" will give a right double quote.  | will give a
  30 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  31 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  32 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  33 .tr \(*W-|\(bv\*(Tr
  34 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  35 .ie n \{\
  36 .    ds -- \(*W-
  37 .    ds PI pi
  38 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  39 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  40 .    ds L" ""
  41 .    ds R" ""
  42 .    ds C` ""
  43 .    ds C' ""
  44 'br\}
  45 .el\{\
  46 .    ds -- \|\(em\|
  47 .    ds PI \(*p
  48 .    ds L" ``
  49 .    ds R" ''
  50 'br\}
  51 .\"
  52 .\" If the F register is turned on, we'll generate index entries on stderr for
  53 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  54 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  55 .\" output yourself in some meaningful fashion.
  56 .if \nF \{\
  57 .    de IX
  58 .    tm Index:\\$1\t\\n%\t"\\$2"
  59 ..
  60 .    nr % 0
  61 .    rr F
  62 .\}
  63 .\"
  64 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  65 .\" way too many mistakes in technical documents.
  66 .hy 0
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "RANLIB 1"
 132 .TH RANLIB 1 "2002-05-14" "binutils-2.12.1" "GNU Development Tools"
 133 .UC
 134 .SH "NAME"
 135 ranlib \- generate index to archive.
 136 .SH "SYNOPSIS"
 137 .IX Header "SYNOPSIS"
 138 ranlib [\fB\-vV\fR] \fIarchive\fR
 139 .SH "DESCRIPTION"
 140 .IX Header "DESCRIPTION"
 141 \&\fBranlib\fR generates an index to the contents of an archive and
 142 stores it in the archive.  The index lists each symbol defined by a
 143 member of an archive that is a relocatable object file.
 144 .PP
 145 You may use \fBnm \-s\fR or \fBnm \-\-print\-armap\fR to list this index.
 146 .PP
 147 An archive with such an index speeds up linking to the library and
 148 allows routines in the library to call each other without regard to
 149 their placement in the archive.
 150 .PP
 151 The \s-1GNU\s0 \fBranlib\fR program is another form of \s-1GNU\s0 \fBar\fR; running
 152 \&\fBranlib\fR is completely equivalent to executing \fBar \-s\fR.
 153 .SH "OPTIONS"
 154 .IX Header "OPTIONS"
 155 .IP "\fB\-v\fR" 4
 156 .IX Item "-v"
 157 .PD 0
 158 .IP "\fB\-V\fR" 4
 159 .IX Item "-V"
 160 .IP "\fB\-\-version\fR" 4
 161 .IX Item "--version"
 162 .PD
 163 Show the version number of \fBranlib\fR.
 164 .SH "SEE ALSO"
 165 .IX Header "SEE ALSO"
 166 \&\fIar\fR\|(1), \fInm\fR\|(1), and the Info entries for \fIbinutils\fR.
 167 .SH "COPYRIGHT"
 168 .IX Header "COPYRIGHT"
 169 Copyright (c) 1991, 92, 93, 94, 95, 96, 97, 98, 99, 2000, 2001, 2002 Free Software Foundation, Inc.
 170 .PP
 171 Permission is granted to copy, distribute and/or modify this document
 172 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.1
 173 or any later version published by the Free Software Foundation;
 174 with no Invariant Sections, with no Front-Cover Texts, and with no
 175 Back-Cover Texts.  A copy of the license is included in the
 176 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".