[deliverable/binutils-gdb.git] / binutils / ranlib.1

.\" Automatically generated by Pod::Man version 1.02
.\" Wed May 30 12:24:28 2001
.\"
.\" Standard preamble:
.\" ======================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Ip \" List item
.br
.ie \\n(.$>=3 .ne \\$3
.el .ne 3
.IP "\\$1" \\$2
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R

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