binutils/ranlib.1

   1 .\" Copyright (c) 1991, 2000 Free Software Foundation
   2 .\" See section COPYING for conditions for redistribution
   3 .TH ranlib 1 "5 November 1991" "Free Software Foundation" "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, 2000 Free Software Foundation, Inc.
  69 .PP
  70 This document is distributed under the terms of the GNU Free
  71 Documenation License.  That license is described in the GNU Free
  72 Documentation License section.
  73
  74 .SH GNU Free Documentation License
  75   Version 1.1, March 2000
  76
  77   Copyright (C) 2000  Free Software Foundation, Inc.
  78   59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  79
  80   Everyone is permitted to copy and distribute verbatim
  81   copies of this license document, but changing it is
  82   not allowed.
  83 .PP
  84 0. PREAMBLE
  85 .PP
  86 The purpose of this License is to make a manual, textbook, or other
  87 written document "free" in the sense of freedom: to assure everyone
  88 the effective freedom to copy and redistribute it, with or without
  89 modifying it, either commercially or noncommercially.  Secondarily,
  90 this License preserves for the author and publisher a way to get
  91 credit for their work, while not being considered responsible for
  92 modifications made by others.
  93 .PP
  94 This License is a kind of "copyleft", which means that derivative
  95 works of the document must themselves be free in the same sense.  It
  96 complements the GNU General Public License, which is a copyleft
  97 license designed for free software.
  98 .PP
  99 We have designed this License in order to use it for manuals for free
 100 software, because free software needs free documentation: a free
 101 program should come with manuals providing the same freedoms that the
 102 software does.  But this License is not limited to software manuals;
 103 it can be used for any textual work, regardless of subject matter or
 104 whether it is published as a printed book.  We recommend this License
 105 principally for works whose purpose is instruction or reference.
 106 .PP
 107 1. APPLICABILITY AND DEFINITIONS
 108 .PP
 109 This License applies to any manual or other work that contains a
 110 notice placed by the copyright holder saying it can be distributed
 111 under the terms of this License.  The "Document", below, refers to any
 112 such manual or work.  Any member of the public is a licensee, and is
 113 addressed as "you".
 114 .PP
 115 A "Modified Version" of the Document means any work containing the
 116 Document or a portion of it, either copied verbatim, or with
 117 modifications and/or translated into another language.
 118 .PP
 119 A "Secondary Section" is a named appendix or a front-matter section of
 120 the Document that deals exclusively with the relationship of the
 121 publishers or authors of the Document to the Document's overall subject
 122 (or to related matters) and contains nothing that could fall directly
 123 within that overall subject.  (For example, if the Document is in part a
 124 textbook of mathematics, a Secondary Section may not explain any
 125 mathematics.)  The relationship could be a matter of historical
 126 connection with the subject or with related matters, or of legal,
 127 commercial, philosophical, ethical or political position regarding
 128 them.
 129 .PP
 130 The "Invariant Sections" are certain Secondary Sections whose titles
 131 are designated, as being those of Invariant Sections, in the notice
 132 that says that the Document is released under this License.
 133 .PP
 134 The "Cover Texts" are certain short passages of text that are listed,
 135 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
 136 the Document is released under this License.
 137 .PP
 138 A "Transparent" copy of the Document means a machine-readable copy,
 139 represented in a format whose specification is available to the
 140 general public, whose contents can be viewed and edited directly and
 141 straightforwardly with generic text editors or (for images composed of
 142 pixels) generic paint programs or (for drawings) some widely available
 143 drawing editor, and that is suitable for input to text formatters or
 144 for automatic translation to a variety of formats suitable for input
 145 to text formatters.  A copy made in an otherwise Transparent file
 146 format whose markup has been designed to thwart or discourage
 147 subsequent modification by readers is not Transparent.  A copy that is
 148 not "Transparent" is called "Opaque".
 149 .PP
 150 Examples of suitable formats for Transparent copies include plain
 151 ASCII without markup, Texinfo input format, LaTeX input format, SGML
 152 or XML using a publicly available DTD, and standard-conforming simple
 153 HTML designed for human modification.  Opaque formats include
 154 PostScript, PDF, proprietary formats that can be read and edited only
 155 by proprietary word processors, SGML or XML for which the DTD and/or
 156 processing tools are not generally available, and the
 157 machine-generated HTML produced by some word processors for output
 158 purposes only.
 159 .PP
 160 The "Title Page" means, for a printed book, the title page itself,
 161 plus such following pages as are needed to hold, legibly, the material
 162 this License requires to appear in the title page.  For works in
 163 formats which do not have any title page as such, "Title Page" means
 164 the text near the most prominent appearance of the work's title,
 165 preceding the beginning of the body of the text.
 166 .PP
 167 2. VERBATIM COPYING
 168 .PP
 169 You may copy and distribute the Document in any medium, either
 170 commercially or noncommercially, provided that this License, the
 171 copyright notices, and the license notice saying this License applies
 172 to the Document are reproduced in all copies, and that you add no other
 173 conditions whatsoever to those of this License.  You may not use
 174 technical measures to obstruct or control the reading or further
 175 copying of the copies you make or distribute.  However, you may accept
 176 compensation in exchange for copies.  If you distribute a large enough
 177 number of copies you must also follow the conditions in section 3.
 178 .PP
 179 You may also lend copies, under the same conditions stated above, and
 180 you may publicly display copies.
 181 .PP
 182 3. COPYING IN QUANTITY
 183 .PP
 184 If you publish printed copies of the Document numbering more than 100,
 185 and the Document's license notice requires Cover Texts, you must enclose
 186 the copies in covers that carry, clearly and legibly, all these Cover
 187 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
 188 the back cover.  Both covers must also clearly and legibly identify
 189 you as the publisher of these copies.  The front cover must present
 190 the full title with all words of the title equally prominent and
 191 visible.  You may add other material on the covers in addition.
 192 Copying with changes limited to the covers, as long as they preserve
 193 the title of the Document and satisfy these conditions, can be treated
 194 as verbatim copying in other respects.
 195 .PP
 196 If the required texts for either cover are too voluminous to fit
 197 legibly, you should put the first ones listed (as many as fit
 198 reasonably) on the actual cover, and continue the rest onto adjacent
 199 pages.
 200 .PP
 201 If you publish or distribute Opaque copies of the Document numbering
 202 more than 100, you must either include a machine-readable Transparent
 203 copy along with each Opaque copy, or state in or with each Opaque copy
 204 a publicly-accessible computer-network location containing a complete
 205 Transparent copy of the Document, free of added material, which the
 206 general network-using public has access to download anonymously at no
 207 charge using public-standard network protocols.  If you use the latter
 208 option, you must take reasonably prudent steps, when you begin
 209 distribution of Opaque copies in quantity, to ensure that this
 210 Transparent copy will remain thus accessible at the stated location
 211 until at least one year after the last time you distribute an Opaque
 212 copy (directly or through your agents or retailers) of that edition to
 213 the public.
 214 .PP
 215 It is requested, but not required, that you contact the authors of the
 216 Document well before redistributing any large number of copies, to give
 217 them a chance to provide you with an updated version of the Document.
 218 .PP
 219 4. MODIFICATIONS
 220 .PP
 221 You may copy and distribute a Modified Version of the Document under
 222 the conditions of sections 2 and 3 above, provided that you release
 223 the Modified Version under precisely this License, with the Modified
 224 Version filling the role of the Document, thus licensing distribution
 225 and modification of the Modified Version to whoever possesses a copy
 226 of it.  In addition, you must do these things in the Modified Version:
 227 .PP
 228 A. Use in the Title Page (and on the covers, if any) a title distinct
 229 from that of the Document, and from those of previous versions
 230 (which should, if there were any, be listed in the History section
 231 of the Document).  You may use the same title as a previous version
 232 if the original publisher of that version gives permission.
 233 .PP
 234 B. List on the Title Page, as authors, one or more persons or entities
 235 responsible for authorship of the modifications in the Modified
 236 Version, together with at least five of the principal authors of the
 237 Document (all of its principal authors, if it has less than five).
 238 .PP
 239 C. State on the Title page the name of the publisher of the
 240 Modified Version, as the publisher.
 241 .PP
 242 D. Preserve all the copyright notices of the Document.
 243 .PP
 244 E. Add an appropriate copyright notice for your modifications
 245 adjacent to the other copyright notices.
 246 .PP
 247 F. Include, immediately after the copyright notices, a license notice
 248 giving the public permission to use the Modified Version under the
 249 terms of this License, in the form shown in the Addendum below.
 250 Preserve in that license notice the full lists of Invariant Sections
 251 and required Cover Texts given in the Document's license notice.
 252 .PP
 253 H. Include an unaltered copy of this License.
 254 .PP
 255 I. Preserve the section entitled "History", and its title, and add to
 256 it an item stating at least the title, year, new authors, and
 257 publisher of the Modified Version as given on the Title Page.  If
 258 there is no section entitled "History" in the Document, create one
 259 stating the title, year, authors, and publisher of the Document as
 260 given on its Title Page, then add an item describing the Modified
 261 Version as stated in the previous sentence.
 262 .PP
 263 J. Preserve the network location, if any, given in the Document for
 264 public access to a Transparent copy of the Document, and likewise
 265 the network locations given in the Document for previous versions
 266 it was based on.  These may be placed in the "History" section.
 267 You may omit a network location for a work that was published at
 268 least four years before the Document itself, or if the original
 269 publisher of the version it refers to gives permission.
 270 .PP
 271 K. In any section entitled "Acknowledgements" or "Dedications",
 272 preserve the section's title, and preserve in the section all the
 273 substance and tone of each of the contributor acknowledgements
 274 and/or dedications given therein.
 275 .PP
 276 L. Preserve all the Invariant Sections of the Document,
 277 unaltered in their text and in their titles.  Section numbers
 278 or the equivalent are not considered part of the section titles.
 279 .PP
 280 M. Delete any section entitled "Endorsements".  Such a section
 281 may not be included in the Modified Version.
 282 .PP
 283 N. Do not retitle any existing section as "Endorsements"
 284 or to conflict in title with any Invariant Section.
 285 .PP
 286 If the Modified Version includes new front-matter sections or
 287 appendices that qualify as Secondary Sections and contain no material
 288 copied from the Document, you may at your option designate some or all
 289 of these sections as invariant.  To do this, add their titles to the
 290 list of Invariant Sections in the Modified Version's license notice.
 291 These titles must be distinct from any other section titles.
 292 .PP
 293 You may add a section entitled "Endorsements", provided it contains
 294 nothing but endorsements of your Modified Version by various
 295 parties--for example, statements of peer review or that the text has
 296 been approved by an organization as the authoritative definition of a
 297 standard.
 298 .PP
 299 You may add a passage of up to five words as a Front-Cover Text, and a
 300 passage of up to 25 words as a Back-Cover Text, to the end of the list
 301 of Cover Texts in the Modified Version.  Only one passage of
 302 Front-Cover Text and one of Back-Cover Text may be added by (or
 303 through arrangements made by) any one entity.  If the Document already
 304 includes a cover text for the same cover, previously added by you or
 305 by arrangement made by the same entity you are acting on behalf of,
 306 you may not add another; but you may replace the old one, on explicit
 307 permission from the previous publisher that added the old one.
 308 .PP
 309 The author(s) and publisher(s) of the Document do not by this License
 310 give permission to use their names for publicity for or to assert or
 311 imply endorsement of any Modified Version.
 312 .PP
 313
 314 5. COMBINING DOCUMENTS
 315 .PP
 316 You may combine the Document with other documents released under this
 317 License, under the terms defined in section 4 above for modified
 318 versions, provided that you include in the combination all of the
 319 Invariant Sections of all of the original documents, unmodified, and
 320 list them all as Invariant Sections of your combined work in its
 321 license notice.
 322 .PP
 323 The combined work need only contain one copy of this License, and
 324 multiple identical Invariant Sections may be replaced with a single
 325 copy.  If there are multiple Invariant Sections with the same name but
 326 different contents, make the title of each such section unique by
 327 adding at the end of it, in parentheses, the name of the original
 328 author or publisher of that section if known, or else a unique number.
 329 Make the same adjustment to the section titles in the list of
 330 Invariant Sections in the license notice of the combined work.
 331 .PP
 332 In the combination, you must combine any sections entitled "History"
 333 in the various original documents, forming one section entitled
 334 "History"; likewise combine any sections entitled "Acknowledgements",
 335 and any sections entitled "Dedications".  You must delete all sections
 336 entitled "Endorsements."
 337 .PP
 338
 339 6. COLLECTIONS OF DOCUMENTS
 340 .PP
 341 You may make a collection consisting of the Document and other documents
 342 released under this License, and replace the individual copies of this
 343 License in the various documents with a single copy that is included in
 344 the collection, provided that you follow the rules of this License for
 345 verbatim copying of each of the documents in all other respects.
 346 .PP
 347 You may extract a single document from such a collection, and distribute
 348 it individually under this License, provided you insert a copy of this
 349 License into the extracted document, and follow this License in all
 350 other respects regarding verbatim copying of that document.
 351 .PP
 352
 353 7. AGGREGATION WITH INDEPENDENT WORKS
 354 .PP
 355 A compilation of the Document or its derivatives with other separate
 356 and independent documents or works, in or on a volume of a storage or
 357 distribution medium, does not as a whole count as a Modified Version
 358 of the Document, provided no compilation copyright is claimed for the
 359 compilation.  Such a compilation is called an "aggregate", and this
 360 License does not apply to the other self-contained works thus compiled
 361 with the Document, on account of their being thus compiled, if they
 362 are not themselves derivative works of the Document.
 363 .PP
 364 If the Cover Text requirement of section 3 is applicable to these
 365 copies of the Document, then if the Document is less than one quarter
 366 of the entire aggregate, the Document's Cover Texts may be placed on
 367 covers that surround only the Document within the aggregate.
 368 Otherwise they must appear on covers around the whole aggregate.
 369 .PP
 370
 371 8. TRANSLATION
 372 .PP
 373 Translation is considered a kind of modification, so you may
 374 distribute translations of the Document under the terms of section 4.
 375 Replacing Invariant Sections with translations requires special
 376 permission from their copyright holders, but you may include
 377 translations of some or all Invariant Sections in addition to the
 378 original versions of these Invariant Sections.  You may include a
 379 translation of this License provided that you also include the
 380 original English version of this License.  In case of a disagreement
 381 between the translation and the original English version of this
 382 License, the original English version will prevail.
 383 .PP
 384
 385 9. TERMINATION
 386 .PP
 387 You may not copy, modify, sublicense, or distribute the Document except
 388 as expressly provided for under this License.  Any other attempt to
 389 copy, modify, sublicense or distribute the Document is void, and will
 390 automatically terminate your rights under this License.  However,
 391 parties who have received copies, or rights, from you under this
 392 License will not have their licenses terminated so long as such
 393 parties remain in full compliance.
 394 .PP
 395
 396 10. FUTURE REVISIONS OF THIS LICENSE
 397 .PP
 398 The Free Software Foundation may publish new, revised versions
 399 of the GNU Free Documentation License from time to time.  Such new
 400 versions will be similar in spirit to the present version, but may
 401 differ in detail to address new problems or concerns.  See
 402 http://www.gnu.org/copyleft/.
 403 .PP
 404 Each version of the License is given a distinguishing version number.
 405 If the Document specifies that a particular numbered version of this
 406 License "or any later version" applies to it, you have the option of
 407 following the terms and conditions either of that specified version or
 408 of any later version that has been published (not as a draft) by the
 409 Free Software Foundation.  If the Document does not specify a version
 410 number of this License, you may choose any version ever published (not
 411 as a draft) by the Free Software Foundation.
 412 .PP
 413
 414 ADDENDUM: How to use this License for your documents
 415 .PP
 416 To use this License in a document you have written, include a copy of
 417 the License in the document and put the following copyright and
 418 license notices just after the title page:
 419 .PP
 420     Copyright (c)  YEAR  YOUR NAME.
 421     Permission is granted to copy, distribute and/or
 422     modify this document under the terms of the GNU
 423     Free Documentation License, Version 1.1 or any later
 424     version published by the Free Software Foundation;
 425     with the Invariant Sections being LIST THEIR TITLES,
 426     with the Front-Cover Texts being LIST, and with the
 427     Back-Cover Texts being LIST.  A copy of the license
 428     is included in the section entitled "GNU Free
 429     Documentation License".
 430 .PP
 431 If you have no Invariant Sections, write "with no Invariant Sections"
 432 instead of saying which ones are invariant.  If you have no
 433 Front-Cover Texts, write "no Front-Cover Texts" instead of
 434 "Front-Cover Texts being LIST"; likewise for Back-Cover Texts.
 435 .PP
 436 If your document contains nontrivial examples of program code, we
 437 recommend releasing these examples in parallel under your choice of
 438 free software license, such as the GNU General Public License,
 439 to permit their use in free software.