Debian Codegraph @

upstream/fedora-44/man1/ranlib.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.47)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\"
56 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "RANLIB 1"
61 .TH RANLIB 1 2026-02-09 binutils-2.46 "GNU Development Tools"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 ranlib \- generate an index to an archive
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 ranlib [\fB\-\-plugin\fR \fIname\fR] [\fB\-DhHvVt\fR] \fIarchive\fR
71 .SH DESCRIPTION
72 .IX Header "DESCRIPTION"
73 \&\fBranlib\fR generates an index to the contents of an archive and
74 stores it in the archive. The index lists each symbol defined by a
75 member of an archive that is a relocatable object file.
76 .PP
77 You may use \fBnm \-s\fR or \fBnm \-\-print\-armap\fR to list this index.
78 .PP
79 An archive with such an index speeds up linking to the library and
80 allows routines in the library to call each other without regard to
81 their placement in the archive.
82 .PP
83 The GNU \fBranlib\fR program is another form of GNU \fBar\fR; running
84 \&\fBranlib\fR is completely equivalent to executing \fBar \-s\fR.
85 .SH OPTIONS
86 .IX Header "OPTIONS"
87 .IP \fB\-h\fR 4
88 .IX Item "-h"
89 .PD 0
90 .IP \fB\-H\fR 4
91 .IX Item "-H"
92 .IP \fB\-\-help\fR 4
93 .IX Item "--help"
94 .PD
95 Show usage information for \fBranlib\fR.
96 .IP \fB\-v\fR 4
97 .IX Item "-v"
98 .PD 0
99 .IP \fB\-V\fR 4
100 .IX Item "-V"
101 .IP \fB\-\-version\fR 4
102 .IX Item "--version"
103 .PD
104 Show the version number of \fBranlib\fR.
105 .IP \fB\-D\fR 4
106 .IX Item "-D"
107 Operate in \fIdeterministic\fR mode. The symbol map archive member\*(Aqs
108 header will show zero for the UID, GID, and timestamp. When this
109 option is used, multiple runs will produce identical output files.
110 .Sp
111 If \fIbinutils\fR was configured with
112 \&\fB\-\-enable\-deterministic\-archives\fR, then this mode is on by
113 default. It can be disabled with the \fB\-U\fR option, described
114 below.
115 .IP \fB\-t\fR 4
116 .IX Item "-t"
117 Update the timestamp of the symbol map of an archive.
118 .IP \fB\-U\fR 4
119 .IX Item "-U"
120 Do \fInot\fR operate in \fIdeterministic\fR mode. This is the
121 inverse of the \fB\-D\fR option, above: the archive index will get
122 actual UID, GID, timestamp, and file mode values.
123 .Sp
124 If \fIbinutils\fR was configured \fIwithout\fR
125 \&\fB\-\-enable\-deterministic\-archives\fR, then this mode is on by
126 default.
127 .IP \fB@\fR\fIfile\fR 4
128 .IX Item "@file"
129 Read command\-line options from \fIfile\fR. The options read are
130 inserted in place of the original @\fIfile\fR option. If \fIfile\fR
131 does not exist, or cannot be read, then the option will be treated
132 literally, and not removed.
133 .Sp
134 Options in \fIfile\fR are separated by whitespace. A whitespace
135 character may be included in an option by surrounding the entire
136 option in either single or double quotes. Any character (including a
137 backslash) may be included by prefixing the character to be included
138 with a backslash. The \fIfile\fR may itself contain additional
139 @\fIfile\fR options; any such options will be processed recursively.
140 .SH "SEE ALSO"
141 .IX Header "SEE ALSO"
142 \&\fBar\fR\|(1), \fBnm\fR\|(1), and the Info entries for \fIbinutils\fR.
143 .SH COPYRIGHT
144 .IX Header "COPYRIGHT"
145 Copyright (c) 1991\-2026 Free Software Foundation, Inc.
146 .PP
147 Permission is granted to copy, distribute and/or modify this document
148 under the terms of the GNU Free Documentation License, Version 1.3
149 or any later version published by the Free Software Foundation;
150 with no Invariant Sections, with no Front\-Cover Texts, and with no
151 Back\-Cover Texts. A copy of the license is included in the
152 section entitled "GNU Free Documentation License".