1 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
9 .de Vb \" Begin verbatim text
14 .de Ve \" End verbatim text
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<>.
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
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
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD. Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
53 . tm Index:\\$1\t\\n%\t"\\$2"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear. Run. Save yourself. No user-serviceable parts.
65 . \" fudge factors for nroff and troff
74 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . \" simple accents for nroff and troff
90 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
97 . \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 . \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 . \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
124 .\" ========================================================================
127 .TH AR 1 "2011-11-21" "binutils-2.21.90" "GNU Development Tools"
128 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
133 ar \- create, modify, and extract from archives
135 .IX Header "SYNOPSIS"
136 ar [\fB\-\-plugin\fR \fIname\fR] [\fB\-X32_64\fR] [\fB\-\fR]\fIp\fR[\fImod\fR [\fIrelpos\fR] [\fIcount\fR]] [\fB\-\-target\fR \fIbfdname\fR] \fIarchive\fR [\fImember\fR...]
138 .IX Header "DESCRIPTION"
139 The \s-1GNU\s0 \fBar\fR program creates, modifies, and extracts from
140 archives. An \fIarchive\fR is a single file holding a collection of
141 other files in a structure that makes it possible to retrieve
142 the original individual files (called \fImembers\fR of the archive).
144 The original files' contents, mode (permissions), timestamp, owner, and
145 group are preserved in the archive, and can be restored on
148 \&\s-1GNU\s0 \fBar\fR can maintain archives whose members have names of any
149 length; however, depending on how \fBar\fR is configured on your
150 system, a limit on member-name length may be imposed for compatibility
151 with archive formats maintained with other tools. If it exists, the
152 limit is often 15 characters (typical of formats related to a.out) or 16
153 characters (typical of formats related to coff).
155 \&\fBar\fR is considered a binary utility because archives of this sort
156 are most often used as \fIlibraries\fR holding commonly needed
159 \&\fBar\fR creates an index to the symbols defined in relocatable
160 object modules in the archive when you specify the modifier \fBs\fR.
161 Once created, this index is updated in the archive whenever \fBar\fR
162 makes a change to its contents (save for the \fBq\fR update operation).
163 An archive with such an index speeds up linking to the library, and
164 allows routines in the library to call each other without regard to
165 their placement in the archive.
167 You may use \fBnm \-s\fR or \fBnm \-\-print\-armap\fR to list this index
168 table. If an archive lacks the table, another form of \fBar\fR called
169 \&\fBranlib\fR can be used to add just the table.
171 \&\s-1GNU\s0 \fBar\fR can optionally create a \fIthin\fR archive,
172 which contains a symbol index and references to the original copies
173 of the member files of the archives. Such an archive is useful
174 for building libraries for use within a local build, where the
175 relocatable objects are expected to remain available, and copying the
176 contents of each object would only waste time and space. Thin archives
177 are also \fIflattened\fR, so that adding one or more archives to a
178 thin archive will add the elements of the nested archive individually.
179 The paths to the elements of the archive are stored relative to the
182 \&\s-1GNU\s0 \fBar\fR is designed to be compatible with two different
183 facilities. You can control its activity using command-line options,
184 like the different varieties of \fBar\fR on Unix systems; or, if you
185 specify the single command-line option \fB\-M\fR, you can control it
186 with a script supplied via standard input, like the \s-1MRI\s0 \*(L"librarian\*(R"
190 \&\s-1GNU\s0 \fBar\fR allows you to mix the operation code \fIp\fR and modifier
191 flags \fImod\fR in any order, within the first command-line argument.
193 If you wish, you may begin the first command-line argument with a
196 The \fIp\fR keyletter specifies what operation to execute; it may be
197 any of the following, but you must specify only one of them:
200 \&\fIDelete\fR modules from the archive. Specify the names of modules to
201 be deleted as \fImember\fR...; the archive is untouched if you
202 specify no files to delete.
204 If you specify the \fBv\fR modifier, \fBar\fR lists each module
208 Use this operation to \fImove\fR members in an archive.
210 The ordering of members in an archive can make a difference in how
211 programs are linked using the library, if a symbol is defined in more
214 If no modifiers are used with \f(CW\*(C`m\*(C'\fR, any members you name in the
215 \&\fImember\fR arguments are moved to the \fIend\fR of the archive;
216 you can use the \fBa\fR, \fBb\fR, or \fBi\fR modifiers to move them to a
217 specified place instead.
220 \&\fIPrint\fR the specified members of the archive, to the standard
221 output file. If the \fBv\fR modifier is specified, show the member
222 name before copying its contents to standard output.
224 If you specify no \fImember\fR arguments, all the files in the archive are
228 \&\fIQuick append\fR; Historically, add the files \fImember\fR... to the end of
229 \&\fIarchive\fR, without checking for replacement.
231 The modifiers \fBa\fR, \fBb\fR, and \fBi\fR do \fInot\fR affect this
232 operation; new members are always placed at the end of the archive.
234 The modifier \fBv\fR makes \fBar\fR list each file as it is appended.
236 Since the point of this operation is speed, the archive's symbol table
237 index is not updated, even if it already existed; you can use \fBar s\fR or
238 \&\fBranlib\fR explicitly to update the symbol table index.
240 However, too many different systems assume quick append rebuilds the
241 index, so \s-1GNU\s0 \fBar\fR implements \fBq\fR as a synonym for \fBr\fR.
244 Insert the files \fImember\fR... into \fIarchive\fR (with
245 \&\fIreplacement\fR). This operation differs from \fBq\fR in that any
246 previously existing members are deleted if their names match those being
249 If one of the files named in \fImember\fR... does not exist, \fBar\fR
250 displays an error message, and leaves undisturbed any existing members
251 of the archive matching that name.
253 By default, new members are added at the end of the file; but you may
254 use one of the modifiers \fBa\fR, \fBb\fR, or \fBi\fR to request
255 placement relative to some existing member.
257 The modifier \fBv\fR used with this operation elicits a line of
258 output for each file inserted, along with one of the letters \fBa\fR or
259 \&\fBr\fR to indicate whether the file was appended (no old member
260 deleted) or replaced.
263 Add an index to the archive, or update it if it already exists. Note
264 this command is an exception to the rule that there can only be one
265 command letter, as it is possible to use it as either a command or a
266 modifier. In either case it does the same thing.
269 Display a \fItable\fR listing the contents of \fIarchive\fR, or those
270 of the files listed in \fImember\fR... that are present in the
271 archive. Normally only the member name is shown; if you also want to
272 see the modes (permissions), timestamp, owner, group, and size, you can
273 request that by also specifying the \fBv\fR modifier.
275 If you do not specify a \fImember\fR, all files in the archive
278 If there is more than one file with the same name (say, \fBfie\fR) in
279 an archive (say \fBb.a\fR), \fBar t b.a fie\fR lists only the
280 first instance; to see them all, you must ask for a complete
281 listing\-\-\-in our example, \fBar t b.a\fR.
284 \&\fIExtract\fR members (named \fImember\fR) from the archive. You can
285 use the \fBv\fR modifier with this operation, to request that
286 \&\fBar\fR list each name as it extracts it.
288 If you do not specify a \fImember\fR, all files in the archive
291 Files cannot be extracted from a thin archive.
292 .IP "\fB\-\-help\fR" 4
294 Displays the list of command line options supported by \fBar\fR
296 .IP "\fB\-\-version\fR" 4
298 Displays the version information of \fBar\fR and then exits.
300 A number of modifiers (\fImod\fR) may immediately follow the \fIp\fR
301 keyletter, to specify variations on an operation's behavior:
304 Add new files \fIafter\fR an existing member of the
305 archive. If you use the modifier \fBa\fR, the name of an existing archive
306 member must be present as the \fIrelpos\fR argument, before the
307 \&\fIarchive\fR specification.
310 Add new files \fIbefore\fR an existing member of the
311 archive. If you use the modifier \fBb\fR, the name of an existing archive
312 member must be present as the \fIrelpos\fR argument, before the
313 \&\fIarchive\fR specification. (same as \fBi\fR).
316 \&\fICreate\fR the archive. The specified \fIarchive\fR is always
317 created if it did not exist, when you request an update. But a warning is
318 issued unless you specify in advance that you expect to create it, by
322 Operate in \fIdeterministic\fR mode. When adding files and the archive
323 index use zero for UIDs, GIDs, timestamps, and use consistent file modes
324 for all files. When this option is used, if \fBar\fR is used with
325 identical options and identical input files, multiple runs will create
326 identical output files regardless of the input files' owners, groups,
327 file modes, or modification times.
330 Truncate names in the archive. \s-1GNU\s0 \fBar\fR will normally permit file
331 names of any length. This will cause it to create archives which are
332 not compatible with the native \fBar\fR program on some systems. If
333 this is a concern, the \fBf\fR modifier may be used to truncate file
334 names when putting them in the archive.
337 Insert new files \fIbefore\fR an existing member of the
338 archive. If you use the modifier \fBi\fR, the name of an existing archive
339 member must be present as the \fIrelpos\fR argument, before the
340 \&\fIarchive\fR specification. (same as \fBb\fR).
343 This modifier is accepted but not used.
346 Uses the \fIcount\fR parameter. This is used if there are multiple
347 entries in the archive with the same name. Extract or delete instance
348 \&\fIcount\fR of the given name from the archive.
351 Preserve the \fIoriginal\fR dates of members when extracting them. If
352 you do not specify this modifier, files extracted from the archive
353 are stamped with the time of extraction.
356 Use the full path name when matching names in the archive. \s-1GNU\s0
357 \&\fBar\fR can not create an archive with a full path name (such archives
358 are not \s-1POSIX\s0 complaint), but other archive creators can. This option
359 will cause \s-1GNU\s0 \fBar\fR to match file names using a complete path
360 name, which can be convenient when extracting a single file from an
361 archive created by another tool.
364 Write an object-file index into the archive, or update an existing one,
365 even if no other change is made to the archive. You may use this modifier
366 flag either with any operation, or alone. Running \fBar s\fR on an
367 archive is equivalent to running \fBranlib\fR on it.
370 Do not generate an archive symbol table. This can speed up building a
371 large library in several steps. The resulting archive can not be used
372 with the linker. In order to build a symbol table, you must omit the
373 \&\fBS\fR modifier on the last execution of \fBar\fR, or you must run
374 \&\fBranlib\fR on the archive.
377 Make the specified \fIarchive\fR a \fIthin\fR archive. If it already
378 exists and is a regular archive, the existing members must be present
379 in the same directory as \fIarchive\fR.
382 Normally, \fBar r\fR... inserts all files
383 listed into the archive. If you would like to insert \fIonly\fR those
384 of the files you list that are newer than existing members of the same
385 names, use this modifier. The \fBu\fR modifier is allowed only for the
386 operation \fBr\fR (replace). In particular, the combination \fBqu\fR is
387 not allowed, since checking the timestamps would lose any speed
388 advantage from the operation \fBq\fR.
391 This modifier requests the \fIverbose\fR version of an operation. Many
392 operations display additional information, such as filenames processed,
393 when the modifier \fBv\fR is appended.
396 This modifier shows the version number of \fBar\fR.
398 \&\fBar\fR ignores an initial option spelt \fB\-X32_64\fR, for
399 compatibility with \s-1AIX\s0. The behaviour produced by this option is the
400 default for \s-1GNU\s0 \fBar\fR. \fBar\fR does not support any of the other
401 \&\fB\-X\fR options; in particular, it does not support \fB\-X32\fR
402 which is the default for \s-1AIX\s0 \fBar\fR.
404 The optional command line switch \fB\-\-plugin\fR \fIname\fR causes
405 \&\fBar\fR to load the plugin called \fIname\fR which adds support
406 for more file formats. This option is only available if the toolchain
407 has been built with plugin support enabled.
409 The optional command line switch \fB\-\-target\fR \fIbfdname\fR
410 specifies that the archive members are in an object code format
411 different from your system's default format. See
412 .IP "\fB@\fR\fIfile\fR" 4
414 Read command-line options from \fIfile\fR. The options read are
415 inserted in place of the original @\fIfile\fR option. If \fIfile\fR
416 does not exist, or cannot be read, then the option will be treated
417 literally, and not removed.
419 Options in \fIfile\fR are separated by whitespace. A whitespace
420 character may be included in an option by surrounding the entire
421 option in either single or double quotes. Any character (including a
422 backslash) may be included by prefixing the character to be included
423 with a backslash. The \fIfile\fR may itself contain additional
424 @\fIfile\fR options; any such options will be processed recursively.
426 .IX Header "SEE ALSO"
427 \&\fInm\fR\|(1), \fIranlib\fR\|(1), and the Info entries for \fIbinutils\fR.
429 .IX Header "COPYRIGHT"
430 Copyright (c) 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
431 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
432 Free Software Foundation, Inc.
434 Permission is granted to copy, distribute and/or modify this document
435 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3
436 or any later version published by the Free Software Foundation;
437 with no Invariant Sections, with no Front-Cover Texts, and with no
438 Back-Cover Texts. A copy of the license is included in the
439 section entitled \*(L"\s-1GNU\s0 Free Documentation License\*(R".
projects / dragonfly.git / blob