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