binutils/doc/ranlib.1

   1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sp \" Vertical space (when we can't use .PP)
   6 .if t .sp .5v
   7 .if n .sp
   8 ..
   9 .de Vb \" Begin verbatim text
  10 .ft CW
  11 .nf
  12 .ne \\$1
  13 ..
  14 .de Ve \" End verbatim text
  15 .ft R
  16 .fi
  17 ..
  18 .\" Set up some character translations and predefined strings.  \*(-- will
  19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
  21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
  22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
  23 .\" nothing in troff, for use with C<>.
  24 .tr \(*W-
  25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  26 .ie n \{\
  27 .    ds -- \(*W-
  28 .    ds PI pi
  29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  31 .    ds L" ""
  32 .    ds R" ""
  33 .    ds C` ""
  34 .    ds C' ""
  35 'br\}
  36 .el\{\
  37 .    ds -- \|\(em\|
  38 .    ds PI \(*p
  39 .    ds L" ``
  40 .    ds R" ''
  41 'br\}
  42 .\"
  43 .\" Escape single quotes in literal strings from groff's Unicode transform.
  44 .ie \n(.g .ds Aq \(aq
  45 .el       .ds Aq '
  46 .\"
  47 .\" If the F register is turned on, we'll generate index entries on stderr for
  48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
  49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  50 .\" output yourself in some meaningful fashion.
  51 .ie \nF \{\
  52 .    de IX
  53 .    tm Index:\\$1\t\\n%\t"\\$2"
  54 ..
  55 .    nr % 0
  56 .    rr F
  57 .\}
  58 .el \{\
  59 .    de IX
  60 ..
  61 .\}
  62 .\"
  63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  65 .    \" fudge factors for nroff and troff
  66 .if n \{\
  67 .    ds #H 0
  68 .    ds #V .8m
  69 .    ds #F .3m
  70 .    ds #[ \f1
  71 .    ds #] \fP
  72 .\}
  73 .if t \{\
  74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  75 .    ds #V .6m
  76 .    ds #F 0
  77 .    ds #[ \&
  78 .    ds #] \&
  79 .\}
  80 .    \" simple accents for nroff and troff
  81 .if n \{\
  82 .    ds ' \&
  83 .    ds ` \&
  84 .    ds ^ \&
  85 .    ds , \&
  86 .    ds ~ ~
  87 .    ds /
  88 .\}
  89 .if t \{\
  90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
  95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
  96 .\}
  97 .    \" troff and (daisy-wheel) nroff accents
  98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
  99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 105 .ds ae a\h'-(\w'a'u*4/10)'e
 106 .ds Ae A\h'-(\w'A'u*4/10)'E
 107 .    \" corrections for vroff
 108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 110 .    \" for low resolution devices (crt and lpr)
 111 .if \n(.H>23 .if \n(.V>19 \
 112 \{\
 113 .    ds : e
 114 .    ds 8 ss
 115 .    ds o a
 116 .    ds d- d\h'-1'\(ga
 117 .    ds D- D\h'-1'\(hy
 118 .    ds th \o'bp'
 119 .    ds Th \o'LP'
 120 .    ds ae ae
 121 .    ds Ae AE
 122 .\}
 123 .rm #[ #] #H #V #F C
 124 .\" ========================================================================
 125 .\"
 126 .IX Title "RANLIB 1"
 127 .TH RANLIB 1 "2012-11-13" "binutils-2.23.1" "GNU Development Tools"
 128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 129 .\" way too many mistakes in technical documents.
 130 .if n .ad l
 131 .nh
 132 .SH "NAME"
 133 ranlib \- generate index to archive.
 134 .SH "SYNOPSIS"
 135 .IX Header "SYNOPSIS"
 136 ranlib [\fB\-\-plugin\fR \fIname\fR] [\fB\-DhHvVt\fR] \fIarchive\fR
 137 .SH "DESCRIPTION"
 138 .IX Header "DESCRIPTION"
 139 \&\fBranlib\fR generates an index to the contents of an archive and
 140 stores it in the archive.  The index lists each symbol defined by a
 141 member of an archive that is a relocatable object file.
 142 .PP
 143 You may use \fBnm \-s\fR or \fBnm \-\-print\-armap\fR to list this index.
 144 .PP
 145 An archive with such an index speeds up linking to the library and
 146 allows routines in the library to call each other without regard to
 147 their placement in the archive.
 148 .PP
 149 The \s-1GNU\s0 \fBranlib\fR program is another form of \s-1GNU\s0 \fBar\fR; running
 150 \&\fBranlib\fR is completely equivalent to executing \fBar \-s\fR.
 151 .SH "OPTIONS"
 152 .IX Header "OPTIONS"
 153 .IP "\fB\-h\fR" 4
 154 .IX Item "-h"
 155 .PD 0
 156 .IP "\fB\-H\fR" 4
 157 .IX Item "-H"
 158 .IP "\fB\-\-help\fR" 4
 159 .IX Item "--help"
 160 .PD
 161 Show usage information for \fBranlib\fR.
 162 .IP "\fB\-v\fR" 4
 163 .IX Item "-v"
 164 .PD 0
 165 .IP "\fB\-V\fR" 4
 166 .IX Item "-V"
 167 .IP "\fB\-\-version\fR" 4
 168 .IX Item "--version"
 169 .PD
 170 Show the version number of \fBranlib\fR.
 171 .IP "\fB\-D\fR" 4
 172 .IX Item "-D"
 173 Operate in \fIdeterministic\fR mode.  The symbol map archive member's
 174 header will show zero for the \s-1UID\s0, \s-1GID\s0, and timestamp.  When this
 175 option is used, multiple runs will produce identical output files.
 176 .Sp
 177 This is the default unless \fIbinutils\fR was configured with
 178 \&\fB\-\-enable\-deterministic\-archives\fR.
 179 .IP "\fB\-t\fR" 4
 180 .IX Item "-t"
 181 Update the timestamp of the symbol map of an archive.
 182 .IP "\fB\-U\fR" 4
 183 .IX Item "-U"
 184 Do \fInot\fR operate in \fIdeterministic\fR mode.  This is the
 185 inverse of the \fB\-D\fR option, above: the archive index will get
 186 actual \s-1UID\s0, \s-1GID\s0, timestamp, and file mode values.
 187 .Sp
 188 This is the default unless \fIbinutils\fR was configured with
 189 \&\fB\-\-enable\-deterministic\-archives\fR.
 190 .IP "\fB@\fR\fIfile\fR" 4
 191 .IX Item "@file"
 192 Read command-line options from \fIfile\fR.  The options read are
 193 inserted in place of the original @\fIfile\fR option.  If \fIfile\fR
 194 does not exist, or cannot be read, then the option will be treated
 195 literally, and not removed.
 196 .Sp
 197 Options in \fIfile\fR are separated by whitespace.  A whitespace
 198 character may be included in an option by surrounding the entire
 199 option in either single or double quotes.  Any character (including a
 200 backslash) may be included by prefixing the character to be included
 201 with a backslash.  The \fIfile\fR may itself contain additional
 202 @\fIfile\fR options; any such options will be processed recursively.
 203 .SH "SEE ALSO"
 204 .IX Header "SEE ALSO"
 205 \&\fIar\fR\|(1), \fInm\fR\|(1), and the Info entries for \fIbinutils\fR.
 206 .SH "COPYRIGHT"
 207 .IX Header "COPYRIGHT"
 208 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998,
 209 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009,
 210 2010, 2011, 2012
 211 Free Software Foundation, Inc.
 212 .PP
 213 Permission is granted to copy, distribute and/or modify this document
 214 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
 215 or any later version published by the Free Software Foundation;
 216 with no Invariant Sections, with no Front-Cover Texts, and with no
 217 Back-Cover Texts.  A copy of the license is included in the
 218 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".