Debian Codegraph @

upstream/debian-unstable/man1/ranlib.1

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
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 .\"
57 .IX Title "RANLIB 1"
58 .TH RANLIB 1 2026-03-05 binutils-2.46 "GNU Development Tools"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 ranlib \- generate an index to an archive
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 ranlib [\fB\-\-plugin\fR \fIname\fR] [\fB\-DhHvVt\fR] \fIarchive\fR
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 \&\fBranlib\fR generates an index to the contents of an archive and
71 stores it in the archive. The index lists each symbol defined by a
72 member of an archive that is a relocatable object file.
73 .PP
74 You may use \fBnm \-s\fR or \fBnm \-\-print\-armap\fR to list this index.
75 .PP
76 An archive with such an index speeds up linking to the library and
77 allows routines in the library to call each other without regard to
78 their placement in the archive.
79 .PP
80 The GNU \fBranlib\fR program is another form of GNU \fBar\fR; running
81 \&\fBranlib\fR is completely equivalent to executing \fBar \-s\fR.
82 .SH OPTIONS
83 .IX Header "OPTIONS"
84 .IP \fB\-h\fR 4
85 .IX Item "-h"
86 .PD 0
87 .IP \fB\-H\fR 4
88 .IX Item "-H"
89 .IP \fB\-\-help\fR 4
90 .IX Item "--help"
91 .PD
92 Show usage information for \fBranlib\fR.
93 .IP \fB\-v\fR 4
94 .IX Item "-v"
95 .PD 0
96 .IP \fB\-V\fR 4
97 .IX Item "-V"
98 .IP \fB\-\-version\fR 4
99 .IX Item "--version"
100 .PD
101 Show the version number of \fBranlib\fR.
102 .IP \fB\-D\fR 4
103 .IX Item "-D"
104 Operate in \fIdeterministic\fR mode. The symbol map archive member's
105 header will show zero for the UID, GID, and timestamp. When this
106 option is used, multiple runs will produce identical output files.
107 .Sp
108 If \fIbinutils\fR was configured with
109 \&\fB\-\-enable\-deterministic\-archives\fR, then this mode is on by
110 default. It can be disabled with the \fB\-U\fR option, described
111 below.
112 .IP \fB\-t\fR 4
113 .IX Item "-t"
114 Update the timestamp of the symbol map of an archive.
115 .IP \fB\-U\fR 4
116 .IX Item "-U"
117 Do \fInot\fR operate in \fIdeterministic\fR mode. This is the
118 inverse of the \fB\-D\fR option, above: the archive index will get
119 actual UID, GID, timestamp, and file mode values.
120 .Sp
121 If \fIbinutils\fR was configured \fIwithout\fR
122 \&\fB\-\-enable\-deterministic\-archives\fR, then this mode is on by
123 default.
124 .IP \fB@\fR\fIfile\fR 4
125 .IX Item "@file"
126 Read command-line options from \fIfile\fR. The options read are
127 inserted in place of the original @\fIfile\fR option. If \fIfile\fR
128 does not exist, or cannot be read, then the option will be treated
129 literally, and not removed.
130 .Sp
131 Options in \fIfile\fR are separated by whitespace. A whitespace
132 character may be included in an option by surrounding the entire
133 option in either single or double quotes. Any character (including a
134 backslash) may be included by prefixing the character to be included
135 with a backslash. The \fIfile\fR may itself contain additional
136 @\fIfile\fR options; any such options will be processed recursively.
137 .SH "SEE ALSO"
138 .IX Header "SEE ALSO"
139 \&\fBar\fR\|(1), \fBnm\fR\|(1), and the Info entries for \fIbinutils\fR.
140 .SH COPYRIGHT
141 .IX Header "COPYRIGHT"
142 Copyright (c) 1991\-2026 Free Software Foundation, Inc.
143 .PP
144 Permission is granted to copy, distribute and/or modify this document
145 under the terms of the GNU Free Documentation License, Version 1.3
146 or any later version published by the Free Software Foundation;
147 with no Invariant Sections, with no Front-Cover Texts, and with no
148 Back-Cover Texts. A copy of the license is included in the
149 section entitled "GNU Free Documentation License".