[unix-history] / usr / src / usr.bin / ar / ar.1

.\"	@(#)ar.1	6.1 (Berkeley) %G%
.\"
.TH AR 1 ""
.AT 3
.SH NAME
ar \- archive and library maintainer
.SH SYNOPSIS
.B ar
key [ posname ] afile name ...
.SH DESCRIPTION
.I Ar
maintains groups of files
combined into a single archive file.
Its main use
is to create and update library files as used by the loader.
It can be used, though, for any similar purpose.
.B N.B:
This version of
.I ar
uses a ASCII-format archive which is portable among the various
machines running \s-2UNIX\s0.
Programs for dealing with older formats are available: see
.IR arcv (8).
.PP
.I Key
is one character from the set
.B drqtpmx,
optionally concatenated with
one or more of
.B vuaibclo.
.I Afile
is the archive file.
The
.I names
are constituent files in the archive file.
The meanings of the
.I key
characters are:
.TP
.B d
Delete the named files from the archive file.
.TP
.B r
Replace the named files in the archive file.
If the optional character
.B u
is used with
.B r,
then only those files with `last-modified' dates later than
the archive files are replaced.
If an optional positioning character from the set
.B abi
is used, then the
.I posname
argument must be present
and specifies that new files are to be placed
after
.RB ( a )
or before
.RB ( b
or
.BR i )
.IR posname .
Otherwise
new files are placed at the end.
.TP
.B q
Quickly append the named files to the end of the archive file.
Optional positioning characters are invalid.
The command does not check whether the added members
are already in the archive.
Useful only to avoid quadratic behavior when creating a large
archive piece-by-piece.
.TP
.B t
Print a table of contents of the archive file.
If no names are given, all files in the archive are tabled.
If names are given, only those files are tabled.
.TP
.B p
Print the named files in the archive.
.TP
.B m
Move the named files to the end of the archive.
If a positioning character is present,
then the
.I posname
argument must be present and,
as in
.B r,
specifies where the files are to be moved.
.TP
.B x
Extract the named files.
If no names are given, all files in the archive are
extracted.
In neither case does
.B x
alter the archive file. Normally the `last-modified' date of each
extracted file is the date when it is extracted. However, if
.B o
is used, the `last-modified' date is reset to the date recorded in the
archive.
.TP
.B v
Verbose.
Under the verbose option,
.I ar
gives a file-by-file
description of the making of a
new archive file from the old archive and the constituent files.
When used with
.B t,
it gives a long listing of all information about the files.
When used with
.BR p ,
it precedes each file with a name.
.TP
.B c
Create.
Normally
.I ar
will create
.I afile
when it needs to.
The create option suppresses the
normal message that is produced when
.I afile
is created.
.TP
.B l
Local.
Normally
.I ar
places its temporary files in the directory /tmp.
This option causes them to be placed in the local directory.
.SH FILES
/tmp/v*	temporaries
.SH "SEE ALSO"
lorder(1), ld(1), ranlib(1), ar(5), arcv(8)
.SH BUGS
If the same file is mentioned twice in an argument list,
it may be put in the archive twice.
.LP
The `last-modified' date of a file will not be altered by the
.B o
option if the user is not the owner of the extracted file, or the super-user.
Commit	Line	Data
58e87b18	1	.\" @(#)ar.1 6.1 (Berkeley) %G%
ca4c99eb	2	.\"
58e87b18	3	.TH AR 1 ""
ca4c99eb KM	4	.AT 3
	5	.SH NAME
	6	ar \- archive and library maintainer
	7	.SH SYNOPSIS
	8	.B ar
	9	key [ posname ] afile name ...
	10	.SH DESCRIPTION
	11	.I Ar
	12	maintains groups of files
	13	combined into a single archive file.
	14	Its main use
	15	is to create and update library files as used by the loader.
	16	It can be used, though, for any similar purpose.
	17	.B N.B:
	18	This version of
	19	.I ar
	20	uses a ASCII-format archive which is portable among the various
	21	machines running \s-2UNIX\s0.
	22	Programs for dealing with older formats are available: see
84dbc84a	23	.IR arcv (8).
ca4c99eb KM	24	.PP
	25	.I Key
	26	is one character from the set
	27	.B drqtpmx,
	28	optionally concatenated with
	29	one or more of
84dbc84a	30	.B vuaibclo.
ca4c99eb KM	31	.I Afile
	32	is the archive file.
	33	The
	34	.I names
	35	are constituent files in the archive file.
	36	The meanings of the
	37	.I key
	38	characters are:
	39	.TP
	40	.B d
	41	Delete the named files from the archive file.
	42	.TP
	43	.B r
	44	Replace the named files in the archive file.
	45	If the optional character
	46	.B u
	47	is used with
	48	.B r,
84dbc84a	49	then only those files with `last-modified' dates later than
ca4c99eb KM	50	the archive files are replaced.
	51	If an optional positioning character from the set
	52	.B abi
	53	is used, then the
	54	.I posname
	55	argument must be present
	56	and specifies that new files are to be placed
	57	after
	58	.RB ( a )
	59	or before
	60	.RB ( b
	61	or
	62	.BR i )
	63	.IR posname .
	64	Otherwise
	65	new files are placed at the end.
	66	.TP
	67	.B q
	68	Quickly append the named files to the end of the archive file.
	69	Optional positioning characters are invalid.
	70	The command does not check whether the added members
	71	are already in the archive.
	72	Useful only to avoid quadratic behavior when creating a large
	73	archive piece-by-piece.
	74	.TP
	75	.B t
	76	Print a table of contents of the archive file.
	77	If no names are given, all files in the archive are tabled.
	78	If names are given, only those files are tabled.
	79	.TP
	80	.B p
	81	Print the named files in the archive.
	82	.TP
	83	.B m
	84	Move the named files to the end of the archive.
	85	If a positioning character is present,
	86	then the
	87	.I posname
	88	argument must be present and,
	89	as in
	90	.B r,
	91	specifies where the files are to be moved.
	92	.TP
	93	.B x
	94	Extract the named files.
	95	If no names are given, all files in the archive are
	96	extracted.
	97	In neither case does
	98	.B x
84dbc84a KM	99	alter the archive file. Normally the `last-modified' date of each
	100	extracted file is the date when it is extracted. However, if
	101	.B o
	102	is used, the `last-modified' date is reset to the date recorded in the
	103	archive.
ca4c99eb KM	104	.TP
	105	.B v
	106	Verbose.
	107	Under the verbose option,
	108	.I ar
	109	gives a file-by-file
	110	description of the making of a
	111	new archive file from the old archive and the constituent files.
	112	When used with
	113	.B t,
	114	it gives a long listing of all information about the files.
	115	When used with
	116	.BR p ,
	117	it precedes each file with a name.
	118	.TP
	119	.B c
	120	Create.
	121	Normally
	122	.I ar
	123	will create
	124	.I afile
	125	when it needs to.
	126	The create option suppresses the
	127	normal message that is produced when
	128	.I afile
	129	is created.
	130	.TP
	131	.B l
	132	Local.
	133	Normally
	134	.I ar
	135	places its temporary files in the directory /tmp.
	136	This option causes them to be placed in the local directory.
	137	.SH FILES
	138	/tmp/v* temporaries
	139	.SH "SEE ALSO"
84dbc84a	140	lorder(1), ld(1), ranlib(1), ar(5), arcv(8)
ca4c99eb KM	141	.SH BUGS
	142	If the same file is mentioned twice in an argument list,
	143	it may be put in the archive twice.
84dbc84a KM	144	.LP
	145	The `last-modified' date of a file will not be altered by the
	146	.B o
	147	option if the user is not the owner of the extracted file, or the super-user.