1 .\" Copyright (c) 2007 Joseph Koshy. All rights reserved.
3 .\" Redistribution and use in source and binary forms, with or without
4 .\" modification, are permitted provided that the following conditions
6 .\" 1. Redistributions of source code must retain the above copyright
7 .\" notice, this list of conditions and the following disclaimer.
8 .\" 2. Redistributions in binary form must reproduce the above copyright
9 .\" notice, this list of conditions and the following disclaimer in the
10 .\" documentation and/or other materials provided with the distribution.
12 .\" This software is provided by Joseph Koshy ``as is'' and
13 .\" any express or implied warranties, including, but not limited to, the
14 .\" implied warranties of merchantability and fitness for a particular purpose
15 .\" are disclaimed. in no event shall Joseph Koshy be liable
16 .\" for any direct, indirect, incidental, special, exemplary, or consequential
17 .\" damages (including, but not limited to, procurement of substitute goods
18 .\" or services; loss of use, data, or profits; or business interruption)
19 .\" however caused and on any theory of liability, whether in contract, strict
20 .\" liability, or tort (including negligence or otherwise) arising in any way
21 .\" out of the use of this software, even if advised of the possibility of
26 .Dd September 24, 2015
46 .Op Fl a Ar position-after
47 .Op Fl b Ar position-before
49 .Op Fl i Ar position-before
77 .Op Fl a Ar position-after
78 .Op Fl b Ar position-before
82 .Op Fl i Ar position-before
122 utility creates and maintains groups of files combined into an
124 Once an archive has been created, new files can be added to it, and
125 existing files can be extracted, deleted or replaced.
127 Files are named in the archive by their last file name component,
128 so if a file referenced by a path containing a
130 is archived, it will be named by the last component of the path.
131 Similarly when matching paths listed on the command line against
132 file names stored in the archive, only the last component of the
133 path will be compared.
137 is for the creation and maintenance of libraries suitable for use
140 although it is not restricted to this purpose.
143 utility can create and manage an archive symbol table (see
145 used to speed up link editing operations.
146 If a symbol table is present in an archive, it will be
147 kept up-to-date by subsequent operations on the archive.
151 utility is used to add an archive symbol table
152 to an existing archive.
156 utility supports the following options:
157 .Bl -tag -width indent
158 .It Fl a Ar member-after
159 When used with option
161 this option specifies that the archive members specified by
164 are moved to after the archive member named by argument
166 When used with option
168 this option specifies that the files specified by arguments
170 are added after the archive member named by argument
172 .It Fl b Ar member-before
173 When used with option
175 this option specifies that the archive members specified by
178 are moved to before the archive member named by argument
180 When used with option
182 this option specifies that the files specified by arguments
184 are added before the archive member named by argument
187 Suppress the informational message printed when a new archive is
194 Prevent extracted files from replacing like-named files
197 Delete the members named by arguments
199 from the archive specified by argument
201 The archive's symbol table, if present, is updated to reflect
202 the new contents of the archive.
204 When used in combination with the
208 option, insert 0's instead of the real mtime, uid and gid values
209 and 0644 instead of file mode from the members named by arguments
211 This ensures that checksums on the resulting archives are reproducible
212 when member contents are identical.
213 This option is enabled by default.
218 options are specified on the command line, the final one takes precedence.
220 Synonymous with option
222 .It Fl i Ar member-before
223 Synonymous with option
226 This option is accepted but ignored.
228 This option is accepted for compatibility with GNU
232 Move archive members specified by arguments
235 If a position has been specified by one of the
240 options, the members are moved to before or after the specified
242 If no position has been specified, the specified members are moved
243 to the end of the archive.
244 If the archive has a symbol table, it is updated to reflect the
245 new contents of the archive.
247 Read and execute MRI librarian commands from standard input.
248 The commands understood by the
250 utility are described in the section
251 .Sx "MRI Librarian Commands" .
253 Preserve the original modification times of members when extracting
256 Write the contents of the specified archive members named by
260 If no members were specified, the contents of all the files in the
261 archive are written in the order they appear in the archive.
263 Append the files specified by arguments
265 to the archive specified by argument
267 without checking if the files already exist in the archive.
268 The archive symbol table will be updated as needed.
269 If the file specified by the argument
271 does not already exist, a new archive will be created.
273 Replace (add) the files specified by arguments
275 in the archive specified by argument
277 creating the archive if necessary.
278 Replacing existing members will not change the order of members within
280 If a file named in arguments
282 does not exist, existing members in the archive that match that
283 name are not changed.
284 New files are added to the end of the archive unless one of the
291 The archive symbol table, if it exists, is updated to reflect the
292 new state of the archive.
294 Add an archive symbol table (see
296 to the archive specified by argument
302 option alone is equivalent to invoking
305 Do not generate an archive symbol table.
307 List the files specified by arguments
309 in the order in which they appear in the archive, one per line.
310 If no files are specified, all files in the archive are listed.
312 Use only the first fifteen characters of the archive member name or
313 command line file name argument when naming archive members.
315 Conditionally update the archive or extract members.
318 option, files named by arguments
320 will be replaced in the archive if they are newer than their
324 option, the members specified by arguments
326 will be extracted only if they are newer than the corresponding
327 files in the file system.
329 When used in combination with the
333 option, insert the real mtime, uid and gid, and file mode values
334 from the members named by arguments
340 options are specified on the command line, the final one takes precedence.
342 Provide verbose output.
351 gives a file-by-file description of the archive modification being
352 performed, which consists of three white-space separated fields:
353 the option letter, a dash
360 displays the description as above, but the initial letter is an
362 if the file is added to the archive, or an
364 if the file replaces a file already in the archive.
367 option, the name of the file enclosed in
371 characters is written to standard output preceded by a single newline
372 character and followed by two newline characters.
373 The contents of the named file follow the file name.
378 displays eight whitespace separated fields:
379 the file permissions as displayed by
381 decimal user and group IDs separated by a slash (
383 the file size in bytes, the file modification time in
386 .Dq "%b %e %H:%M %Y" ,
387 and the name of the file.
389 Print a version string and exit.
391 Extract archive members specified by arguments
393 into the current directory.
394 If no members have been specified, extract all members of the archive.
395 If the file corresponding to an extracted member does not exist it
397 If the file corresponding to an extracted member does exist, its owner
398 and group will not be changed while its contents will be overwritten
399 and its permissions will set to that entered in the archive.
400 The file's access and modification time would be that of the time
401 of extraction unless the
403 option was specified.
405 This option is accepted but ignored.
407 .Ss "MRI Librarian Commands"
410 option is specified, the
412 utility will read and execute commands from its standard input.
413 If standard input is a terminal, the
415 utility will display the prompt
417 before reading a line, and will continue operation even if errors are
419 If standard input is not a terminal, the
421 utility will not display a prompt and will terminate execution on
422 encountering an error.
424 Each input line contains a single command.
425 Words in an input line are separated by whitespace characters.
426 The first word of the line is the command, the remaining words are
427 the arguments to the command.
428 The command word may be specified in either case.
429 Arguments may be separated by commas or blanks.
431 Empty lines are allowed and are ignored.
432 Long lines are continued by ending them with the
440 characters start a comment.
441 Comments extend till the end of the line.
443 When executing an MRI librarian script the
445 utility works on a temporary copy of an archive.
446 Changes to the copy are made permanent using the
450 Commands understood by the
453 .Bl -tag -width indent
454 .It Ic addlib Ar archive | Ic addlib Ar archive Pq Ar member Oo Li , Ar member Oc Ns ...
455 Add the contents of the archive named by argument
457 to the current archive.
458 If specific members are named using the arguments
460 then those members are added to the current archive.
461 If no members are specified, the entire contents of the archive
462 are added to the current archive.
463 .It Ic addmod Ar member Oo Li , Ar member Oc Ns ...
464 Add the files named by arguments
466 to the current archive.
468 Discard all the contents of the current archive.
469 .It Ic create Ar archive
470 Create a new archive named by the argument
472 and makes it the current archive.
473 If the named archive already exists, it will be overwritten
477 .It Ic delete Ar module Oo Li , Ar member Oc Ns ...
478 Delete the modules named by the arguments
480 from the current archive.
481 .It Ic directory Ar archive Po Ar member Oo Li , Ar member Oc Ns ... Pc Op Ar outputfile
482 List each named module in the archive.
483 The format of the output depends on the verbosity setting set using
487 Output is sent to standard output, or to the file specified by
491 Exit successfully from the
494 Any unsaved changes to the current archive will be discarded.
495 .It Ic extract Ar member Oo Li , Ar member Oc Ns ...
496 Extract the members named by the arguments
498 from the current archive.
500 Display the contents of the current archive in verbose style.
501 .It Ic open Ar archive
502 Open the archive named by argument
504 and make it the current archive.
505 .It Ic replace Ar member Oo Li , Ar member Oc Ns ...
506 Replace named members in the current archive with the files specified
509 The files must be present in the current directory and the named
510 modules must already exist in the current archive.
512 Commit all changes to the current archive.
514 Toggle the verbosity of the
519 To create a new archive
521 containing three files
527 .Dl "ar -rc ex.a ex1.o ex2.o ex3.o"
529 To add an archive symbol table to an existing archive
539 .D1 "ar -d ex.a ex1.o"
541 To verbosely list the contents of archive
546 To create a new archive
552 using MRI librarian commands, use the following script:
553 .Bd -literal -offset indent
554 create ex.a * specify the output archive
555 addmod ex1.o ex2.o * add modules
556 save * save pending changes
557 end * exit the utility
568 .Sh STANDARDS COMPLIANCE
571 utility's support for the
587 options is believed to be compliant with
592 command first appeared in AT&T UNIX Version 1.
595 .An "Kai Wang" Aq kaiw@FreeBSD.org