2 .\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
10 .de Vb \" Begin verbatim text
15 .de Ve \" End verbatim text
19 .\" Set up some character translations and predefined strings. \*(-- will
20 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
21 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
22 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
23 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
24 .\" nothing in troff, for use with C<>.
26 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
30 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
31 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
44 .\" Escape single quotes in literal strings from groff's Unicode transform.
48 .\" If the F register is turned on, we'll generate index entries on stderr for
49 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
50 .\" entries marked with X<> in POD. Of course, you'll have to process the
51 .\" output yourself in some meaningful fashion.
54 . tm Index:\\$1\t\\n%\t"\\$2"
64 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
65 .\" Fear. Run. Save yourself. No user-serviceable parts.
66 . \" fudge factors for nroff and troff
75 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
81 . \" simple accents for nroff and troff
91 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
92 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
93 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
94 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
95 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
96 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
98 . \" troff and (daisy-wheel) nroff accents
99 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
100 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
101 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
102 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
103 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
104 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
105 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
106 .ds ae a\h'-(\w'a'u*4/10)'e
107 .ds Ae A\h'-(\w'A'u*4/10)'E
108 . \" corrections for vroff
109 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
110 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
111 . \" for low resolution devices (crt and lpr)
112 .if \n(.H>23 .if \n(.V>19 \
125 .\" ========================================================================
127 .IX Title "LLVM-AR 1"
128 .TH LLVM-AR 1 "2012-04-05" "LLVM 3.1" "LLVM Command Guide"
129 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
130 .\" way too many mistakes in technical documents.
134 llvm\-ar \- LLVM archiver
136 .IX Header "SYNOPSIS"
137 \&\fBllvm-ar\fR [\-]{dmpqrtx}[Rabfikouz] [relpos] [count] <archive> [files...]
139 .IX Header "DESCRIPTION"
140 The \fBllvm-ar\fR command is similar to the common Unix utility, \f(CW\*(C`ar\*(C'\fR. It
141 archives several files together into a single file. The intent for this is
142 to produce archive libraries by \s-1LLVM\s0 bitcode that can be linked into an
143 \&\s-1LLVM\s0 program. However, the archive can contain any kind of file. By default,
144 \&\fBllvm-ar\fR generates a symbol table that makes linking faster because
145 only the symbol table needs to be consulted, not each individual file member
148 The \fBllvm-ar\fR command can be used to \fIread\fR both \s-1SVR4\s0 and \s-1BSD\s0 style archive
149 files. However, it cannot be used to write them. While the \fBllvm-ar\fR command
150 produces files that are \fIalmost\fR identical to the format used by other \f(CW\*(C`ar\*(C'\fR
151 implementations, it has two significant departures in order to make the
152 archive appropriate for \s-1LLVM\s0. The first departure is that \fBllvm-ar\fR only
153 uses \s-1BSD4\s0.4 style long path names (stored immediately after the header) and
154 never contains a string table for long names. The second departure is that the
155 symbol table is formated for efficient construction of an in-memory data
156 structure that permits rapid (red-black tree) lookups. Consequently, archives
157 produced with \fBllvm-ar\fR usually won't be readable or editable with any
158 \&\f(CW\*(C`ar\*(C'\fR implementation or useful for linking. Using the \f(CW\*(C`f\*(C'\fR modifier to flatten
159 file names will make the archive readable by other \f(CW\*(C`ar\*(C'\fR implementations
160 but not for linking because the symbol table format for \s-1LLVM\s0 is unique. If an
161 \&\s-1SVR4\s0 or \s-1BSD\s0 style archive is used with the \f(CW\*(C`r\*(C'\fR (replace) or \f(CW\*(C`q\*(C'\fR (quick
162 update) operations, the archive will be reconstructed in \s-1LLVM\s0 format. This
163 means that the string table will be dropped (in deference to \s-1BSD\s0 4.4 long names)
164 and an \s-1LLVM\s0 symbol table will be added (by default). The system symbol table
167 Here's where \fBllvm-ar\fR departs from previous \f(CW\*(C`ar\*(C'\fR implementations:
168 .IP "\fISymbol Table\fR" 4
169 .IX Item "Symbol Table"
170 Since \fBllvm-ar\fR is intended to archive bitcode files, the symbol table
171 won't make much sense to anything but \s-1LLVM\s0. Consequently, the symbol table's
172 format has been simplified. It consists simply of a sequence of pairs
173 of a file member index number as an \s-1LSB\s0 4byte integer and a null-terminated
175 .IP "\fILong Paths\fR" 4
176 .IX Item "Long Paths"
177 Some \f(CW\*(C`ar\*(C'\fR implementations (\s-1SVR4\s0) use a separate file member to record long
178 path names (> 15 characters). \fBllvm-ar\fR takes the \s-1BSD\s0 4.4 and Mac \s-1OS\s0 X
179 approach which is to simply store the full path name immediately preceding
180 the data for the file. The path name is null terminated and may contain the
182 .IP "\fICompression\fR" 4
183 .IX Item "Compression"
184 \&\fBllvm-ar\fR can compress the members of an archive to save space. The
185 compression used depends on what's available on the platform and what choices
186 the \s-1LLVM\s0 Compressor utility makes. It generally favors bzip2 but will select
187 between \*(L"no compression\*(R" or bzip2 depending on what makes sense for the
189 .IP "\fIDirectory Recursion\fR" 4
190 .IX Item "Directory Recursion"
191 Most \f(CW\*(C`ar\*(C'\fR implementations do not recurse through directories but simply
192 ignore directories if they are presented to the program in the \fIfiles\fR
193 option. \fBllvm-ar\fR, however, can recurse through directory structures and
194 add all the files under a directory, if requested.
195 .IP "\fI\s-1TOC\s0 Verbose Output\fR" 4
196 .IX Item "TOC Verbose Output"
197 When \fBllvm-ar\fR prints out the verbose table of contents (\f(CW\*(C`tv\*(C'\fR option), it
198 precedes the usual output with a character indicating the basic kind of
199 content in the file. A blank means the file is a regular file. A 'Z' means
200 the file is compressed. A 'B' means the file is an \s-1LLVM\s0 bitcode file. An
201 \&'S' means the file is the symbol table.
204 The options to \fBllvm-ar\fR are compatible with other \f(CW\*(C`ar\*(C'\fR implementations.
205 However, there are a few modifiers (\fIzR\fR) that are not found in other
206 \&\f(CW\*(C`ar\*(C'\fRs. The options to \fBllvm-ar\fR specify a single basic operation to
207 perform on the archive, a variety of modifiers for that operation, the
208 name of the archive file, and an optional list of file names. These options
209 are used to determine how \fBllvm-ar\fR should process the archive file.
211 The Operations and Modifiers are explained in the sections below. The minimal
212 set of options is at least one operator and the name of the archive. Typically
213 archive files end with a \f(CW\*(C`.a\*(C'\fR suffix, but this is not required. Following
214 the \fIarchive-name\fR comes a list of \fIfiles\fR that indicate the specific members
215 of the archive to operate on. If the \fIfiles\fR option is not specified, it
216 generally means either \*(L"none\*(R" or \*(L"all\*(R" members, depending on the operation.
218 .IX Subsection "Operations"
221 Delete files from the archive. No modifiers are applicable to this operation.
222 The \fIfiles\fR options specify which members should be removed from the
223 archive. It is not an error if a specified file does not appear in the archive.
224 If no \fIfiles\fR are specified, the archive is not modified.
227 Move files from one location in the archive to another. The \fIa\fR, \fIb\fR, and
228 \&\fIi\fR modifiers apply to this operation. The \fIfiles\fR will all be moved
229 to the location given by the modifiers. If no modifiers are used, the files
230 will be moved to the end of the archive. If no \fIfiles\fR are specified, the
231 archive is not modified.
234 Print files to the standard output. The \fIk\fR modifier applies to this
235 operation. This operation simply prints the \fIfiles\fR indicated to the
236 standard output. If no \fIfiles\fR are specified, the entire archive is printed.
237 Printing bitcode files is ill-advised as they might confuse your terminal
238 settings. The \fIp\fR operation never modifies the archive.
241 Quickly append files to the end of the archive. The \fIR\fR, \fIf\fR, and \fIz\fR
242 modifiers apply to this operation. This operation quickly adds the
243 \&\fIfiles\fR to the archive without checking for duplicates that should be
244 removed first. If no \fIfiles\fR are specified, the archive is not modified.
245 Because of the way that \fBllvm-ar\fR constructs the archive file, its dubious
246 whether the \fIq\fR operation is any faster than the \fIr\fR operation.
249 Replace or insert file members. The \fIR\fR, \fIa\fR, \fIb\fR, \fIf\fR, \fIu\fR, and \fIz\fR
250 modifiers apply to this operation. This operation will replace existing
251 \&\fIfiles\fR or insert them at the end of the archive if they do not exist. If no
252 \&\fIfiles\fR are specified, the archive is not modified.
255 Print the table of contents. Without any modifiers, this operation just prints
256 the names of the members to the standard output. With the \fIv\fR modifier,
257 \&\fBllvm-ar\fR also prints out the file type (B=bitcode, Z=compressed, S=symbol
258 table, blank=regular file), the permission mode, the owner and group, the
259 size, and the date. If any \fIfiles\fR are specified, the listing is only for
260 those files. If no \fIfiles\fR are specified, the table of contents for the
261 whole archive is printed.
264 Extract archive members back to files. The \fIo\fR modifier applies to this
265 operation. This operation retrieves the indicated \fIfiles\fR from the archive
266 and writes them back to the operating system's file system. If no
267 \&\fIfiles\fR are specified, the entire archive is extract.
268 .SS "Modifiers (operation specific)"
269 .IX Subsection "Modifiers (operation specific)"
270 The modifiers below are specific to certain operations. See the Operations
271 section (above) to determine which modifiers are applicable to which operations.
274 When inserting or moving member files, this option specifies the destination of
275 the new files as being \f(CW\*(C`a\*(C'\fRfter the \fIrelpos\fR member. If \fIrelpos\fR is not found,
276 the files are placed at the end of the archive.
279 When inserting or moving member files, this option specifies the destination of
280 the new files as being \f(CW\*(C`b\*(C'\fRefore the \fIrelpos\fR member. If \fIrelpos\fR is not
281 found, the files are placed at the end of the archive. This modifier is
282 identical to the the \fIi\fR modifier.
285 Normally, \fBllvm-ar\fR stores the full path name to a file as presented to it on
286 the command line. With this option, truncated (15 characters max) names are
287 used. This ensures name compatibility with older versions of \f(CW\*(C`ar\*(C'\fR but may also
288 thwart correct extraction of the files (duplicates may overwrite). If used with
289 the \fIR\fR option, the directory recursion will be performed but the file names
290 will all be \f(CW\*(C`f\*(C'\fRlattened to simple file names.
293 A synonym for the \fIb\fR option.
296 Normally, \fBllvm-ar\fR will not print the contents of bitcode files when the
297 \&\fIp\fR operation is used. This modifier defeats the default and allows the
298 bitcode members to be printed.
301 This option is ignored by \fBllvm-ar\fR but provided for compatibility.
304 When extracting files, this option will cause \fBllvm-ar\fR to preserve the
305 original modification times of the files it writes.
308 use full path names when matching
311 This modifier instructions the \fIr\fR option to recursively process directories.
312 Without \fIR\fR, directories are ignored and only those \fIfiles\fR that refer to
313 files will be added to the archive. When \fIR\fR is used, any directories specified
314 with \fIfiles\fR will be scanned (recursively) to find files to be added to the
315 archive. Any file whose name begins with a dot will not be added.
318 When replacing existing files in the archive, only replace those files that have
319 a time stamp than the time stamp of the member in the archive.
322 When inserting or replacing any file in the archive, compress the file first.
324 modifier is safe to use when (previously) compressed bitcode files are added to
325 the archive; the compressed bitcode files will not be doubly compressed.
326 .SS "Modifiers (generic)"
327 .IX Subsection "Modifiers (generic)"
328 The modifiers below may be applied to any operation.
331 For all operations, \fBllvm-ar\fR will always create the archive if it doesn't
332 exist. Normally, \fBllvm-ar\fR will print a warning message indicating that the
333 archive is being created. Using this modifier turns off that warning.
336 This modifier requests that an archive index (or symbol table) be added to the
337 archive. This is the default mode of operation. The symbol table will contain
338 all the externally visible functions and global variables defined by all the
339 bitcode files in the archive. Using this modifier is more efficient that using
340 llvm-ranlib which also creates the symbol table.
343 This modifier is the opposite of the \fIs\fR modifier. It instructs \fBllvm-ar\fR to
344 not build the symbol table. If both \fIs\fR and \fIS\fR are used, the last modifier to
345 occur in the options will prevail.
348 This modifier instructs \fBllvm-ar\fR to be verbose about what it is doing. Each
349 editing operation taken against the archive will produce a line of output saying
352 .IX Header "STANDARDS"
353 The \fBllvm-ar\fR utility is intended to provide a superset of the \s-1IEEE\s0 Std 1003.2
354 (\s-1POSIX\s0.2) functionality for \f(CW\*(C`ar\*(C'\fR. \fBllvm-ar\fR can read both \s-1SVR4\s0 and \s-1BSD4\s0.4 (or
355 Mac \s-1OS\s0 X) archives. If the \f(CW\*(C`f\*(C'\fR modifier is given to the \f(CW\*(C`x\*(C'\fR or \f(CW\*(C`r\*(C'\fR operations
356 then \fBllvm-ar\fR will write \s-1SVR4\s0 compatible archives. Without this modifier,
357 \&\fBllvm-ar\fR will write \s-1BSD4\s0.4 compatible archives that have long names
358 immediately after the header and indicated using the \*(L"#1/ddd\*(R" notation for the
361 .IX Header "FILE FORMAT"
362 The file format for \s-1LLVM\s0 Archive files is similar to that of \s-1BSD\s0 4.4 or Mac \s-1OSX\s0
363 archive files. In fact, except for the symbol table, the \f(CW\*(C`ar\*(C'\fR commands on those
364 operating systems should be able to read \s-1LLVM\s0 archive files. The details of the
367 Each archive begins with the archive magic number which is the eight printable
368 characters \*(L"!<arch>\en\*(R" where \en represents the newline character (0x0A).
369 Following the magic number, the file is composed of even length members that
370 begin with an archive header and end with a \en padding character if necessary
371 (to make the length even). Each file member is composed of a header (defined
372 below), an optional newline-terminated \*(L"long file name\*(R" and the contents of
375 The fields of the header are described in the items below. All fields of the
376 header contain only \s-1ASCII\s0 characters, are left justified and are right padded
377 with space characters.
378 .IP "name \- char[16]" 4
379 .IX Item "name - char[16]"
380 This field of the header provides the name of the archive member. If the name is
381 longer than 15 characters or contains a slash (/) character, then this field
382 contains \f(CW\*(C`#1/nnn\*(C'\fR where \f(CW\*(C`nnn\*(C'\fR provides the length of the name and the \f(CW\*(C`#1/\*(C'\fR
383 is literal. In this case, the actual name of the file is provided in the \f(CW\*(C`nnn\*(C'\fR
384 bytes immediately following the header. If the name is 15 characters or less, it
385 is contained directly in this field and terminated with a slash (/) character.
386 .IP "date \- char[12]" 4
387 .IX Item "date - char[12]"
388 This field provides the date of modification of the file in the form of a
389 decimal encoded number that provides the number of seconds since the epoch
390 (since 00:00:00 Jan 1, 1970) per Posix specifications.
391 .IP "uid \- char[6]" 4
392 .IX Item "uid - char[6]"
393 This field provides the user id of the file encoded as a decimal \s-1ASCII\s0 string.
394 This field might not make much sense on non-Unix systems. On Unix, it is the
395 same value as the st_uid field of the stat structure returned by the \fIstat\fR\|(2)
396 operating system call.
397 .IP "gid \- char[6]" 4
398 .IX Item "gid - char[6]"
399 This field provides the group id of the file encoded as a decimal \s-1ASCII\s0 string.
400 This field might not make much sense on non-Unix systems. On Unix, it is the
401 same value as the st_gid field of the stat structure returned by the \fIstat\fR\|(2)
402 operating system call.
403 .IP "mode \- char[8]" 4
404 .IX Item "mode - char[8]"
405 This field provides the access mode of the file encoded as an octal \s-1ASCII\s0
406 string. This field might not make much sense on non-Unix systems. On Unix, it
407 is the same value as the st_mode field of the stat structure returned by the
408 \&\fIstat\fR\|(2) operating system call.
409 .IP "size \- char[10]" 4
410 .IX Item "size - char[10]"
411 This field provides the size of the file, in bytes, encoded as a decimal \s-1ASCII\s0
412 string. If the size field is negative (starts with a minus sign, 0x02D), then
413 the archive member is stored in compressed form. The first byte of the archive
414 member's data indicates the compression type used. A value of 0 (0x30) indicates
415 that no compression was used. A value of 2 (0x32) indicates that bzip2
416 compression was used.
417 .IP "fmag \- char[2]" 4
418 .IX Item "fmag - char[2]"
419 This field is the archive file member magic number. Its content is always the
420 two characters back tick (0x60) and newline (0x0A). This provides some measure
421 utility in identifying archive files that have been corrupted.
423 The \s-1LLVM\s0 symbol table has the special name \*(L"#_LLVM_SYM_TAB_#\*(R". It is presumed
424 that no regular archive member file will want this name. The \s-1LLVM\s0 symbol table
425 is simply composed of a sequence of triplets: byte offset, length of symbol,
426 and the symbol itself. Symbols are not null or newline terminated. Here are
427 the details on each of these items:
428 .IP "offset \- vbr encoded 32\-bit integer" 4
429 .IX Item "offset - vbr encoded 32-bit integer"
430 The offset item provides the offset into the archive file where the bitcode
431 member is stored that is associated with the symbol. The offset value is 0
432 based at the start of the first \*(L"normal\*(R" file member. To derive the actual
433 file offset of the member, you must add the number of bytes occupied by the file
434 signature (8 bytes) and the symbol tables. The value of this item is encoded
435 using variable bit rate encoding to reduce the size of the symbol table.
436 Variable bit rate encoding uses the high bit (0x80) of each byte to indicate
437 if there are more bytes to follow. The remaining 7 bits in each byte carry bits
438 from the value. The final byte does not have the high bit set.
439 .IP "length \- vbr encoded 32\-bit integer" 4
440 .IX Item "length - vbr encoded 32-bit integer"
441 The length item provides the length of the symbol that follows. Like this
442 \&\fIoffset\fR item, the length is variable bit rate encoded.
443 .IP "symbol \- character array" 4
444 .IX Item "symbol - character array"
445 The symbol item provides the text of the symbol that is associated with the
446 \&\fIoffset\fR. The symbol is not terminated by any character. Its length is provided
447 by the \fIlength\fR field. Note that is allowed (but unwise) to use non-printing
448 characters (even 0x00) in the symbol. This allows for multiple encodings of
451 .IX Header "EXIT STATUS"
452 If \fBllvm-ar\fR succeeds, it will exit with 0. A usage error, results
453 in an exit code of 1. A hard (file system typically) error results in an
454 exit code of 2. Miscellaneous or unknown errors result in an
457 .IX Header "SEE ALSO"
458 llvm-ranlib, \fIar\fR\|(1)
461 Maintained by the \s-1LLVM\s0 Team (<http://llvm.org/>).
projects / FreeBSD / stable / 9.git / blob