[unix-history] / usr / contrib / ansi / ansitape.n

.TH ANSITAPE LOCAL "4/10/85 UCB Local"
.SH NAME
ansitape - ANSI standard tape handler
.SH SYNOPSIS
.B ansitape
[key] [keyargs] [files]
.SH DESCRIPTION
.I Ansitape
reads and writes magnetic tapes written in
ANSI standard format
(called ``Files-11'' by DEC).
Tapes written by
.I ansitape
are labeled with the first 6 characters of the machine name by default.
Actions are controlled by the
.I key
argument.
The
.I key
is a string of characters containing at
most one function letter.
Other arguments to the command are
a tape label and file names specifying which files are
to be written onto or extracted from the tape.
.PP
The function portion of the key is
specified by one of the following letters:
.TP 8
.B r
The named files are written at the end of the tape.
The
.B c
function implies this.
.TP 8
.B x
The named files are extracted from the tape.
If no file argument is given,
the entire contents of the tape is extracted.
Note that if the tape has duplicated file names,
only the last file of a given name can
be extracted.
.TP 8
.B t
The names of the specified files are listed
each time they occur on the tape.
If no file argument is given,
all files on the tape are listed.
.TP 8
.B c
Create a new tape; writing begins at the
beginning of the tape instead of after
the last file.
This command implies
.B r.
.PP
The following characters may be used in
addition to the letter which selects
the function desired.
.TP 8
.B f
This argument allows the selection of a different tape
device.  
The next word in the keyargs list is taken to be
the full name of a device to write the tape on.
The default is /dev/rmt12.
.TP 8
.B n
The
.B n
option allows the user to specify as the next argument in the keyargs list,
a control file 
containing the names of files to put on the tape.  
If the file name is '-', the control file will, instead, be read
from standard input.
The control file contains one line for each file
to be placed on the tape.
Each line has two names, the name of the file on
the local machine, and the name it is to have when
placed on the tape.  This allows for more convenient
flattening of hierarchies when placing them on tape.
If the second name is omitted, the UNIX file name will be
used on the tape also.
This argument can only be used with the 
.B r 
and 
.B c
functions.
.TP 8
.B l
The 
.B l
option allows the user to specify the label to be placed on the tape. 
The next argument in the keyargs list is taken as the tape label, which
will be space padded or truncated to six characters.
This option is meaningless unless 
.B c
is also specified.
.TP 8
.B v
Normally
.I ansitape
works relatively silently.
The
.B v
(verbose) option causes it to type 
information about each file as it processes it.
.TP 8
.B b
The
.B b
option allows the user to select the blocksize to be used for the
tape.
By default,
.I ansitape
uses the maximum block size permitted by the ANSI standard, 2048.
Some systems will permit a much large block size, and if large
files are being put on the tape it may be advantageous to do so.
.I Ansitape
will take the next argument of the keyargs list as the blocksize for the tape.
Values below 18 or above 32k will be limited to that range.
The standard scale factors b=512 and k=1024 are accepted.
.PP
.I Ansitape
will not copy directories, character or block special files,
symbolic links, sockets, or binary executables.  
Attempts to put these on tape will result in warnings, and they will
be skipped completely.
.SH FILES
/dev/rmt12
.br
.SH DIAGNOSTICS
A warning message will be generated when a record exceeds the maximum record
length and the affected file will be truncated.
.br
.SH BUGS
Ansitape quietly truncates names longer than 17 characters.
.br
ANSI 'f' format files can be read but not written.
.br
Multivolume tapes can not be handled.
.br
Commit	Line	Data
6de9a741 C	1	.TH ANSITAPE LOCAL "4/10/85 UCB Local"
	2	.SH NAME
	3	ansitape - ANSI standard tape handler
	4	.SH SYNOPSIS
	5	.B ansitape
	6	[key] [keyargs] [files]
	7	.SH DESCRIPTION
	8	.I Ansitape
	9	reads and writes magnetic tapes written in
	10	ANSI standard format
	11	(called ``Files-11'' by DEC).
	12	Tapes written by
	13	.I ansitape
	14	are labeled with the first 6 characters of the machine name by default.
	15	Actions are controlled by the
	16	.I key
	17	argument.
	18	The
	19	.I key
	20	is a string of characters containing at
	21	most one function letter.
	22	Other arguments to the command are
	23	a tape label and file names specifying which files are
	24	to be written onto or extracted from the tape.
	25	.PP
	26	The function portion of the key is
	27	specified by one of the following letters:
	28	.TP 8
	29	.B r
	30	The named files are written at the end of the tape.
	31	The
	32	.B c
	33	function implies this.
	34	.TP 8
	35	.B x
	36	The named files are extracted from the tape.
	37	If no file argument is given,
	38	the entire contents of the tape is extracted.
	39	Note that if the tape has duplicated file names,
	40	only the last file of a given name can
	41	be extracted.
	42	.TP 8
	43	.B t
	44	The names of the specified files are listed
	45	each time they occur on the tape.
	46	If no file argument is given,
	47	all files on the tape are listed.
	48	.TP 8
	49	.B c
	50	Create a new tape; writing begins at the
	51	beginning of the tape instead of after
	52	the last file.
	53	This command implies
	54	.B r.
	55	.PP
	56	The following characters may be used in
	57	addition to the letter which selects
	58	the function desired.
	59	.TP 8
	60	.B f
	61	This argument allows the selection of a different tape
	62	device.
	63	The next word in the keyargs list is taken to be
	64	the full name of a device to write the tape on.
65	The default is /dev/rmt12.
66	.TP 8
67	.B n
68	The
69	.B n
70	option allows the user to specify as the next argument in the keyargs list,
71	a control file
72	containing the names of files to put on the tape.
73	If the file name is '-', the control file will, instead, be read
74	from standard input.
75	The control file contains one line for each file
76	to be placed on the tape.
77	Each line has two names, the name of the file on
78	the local machine, and the name it is to have when
79	placed on the tape. This allows for more convenient
80	flattening of hierarchies when placing them on tape.
81	If the second name is omitted, the UNIX file name will be
82	used on the tape also.
83	This argument can only be used with the
84	.B r
85	and
86	.B c
87	functions.
88	.TP 8
89	.B l
90	The
91	.B l
92	option allows the user to specify the label to be placed on the tape.
93	The next argument in the keyargs list is taken as the tape label, which
94	will be space padded or truncated to six characters.
95	This option is meaningless unless
96	.B c
97	is also specified.
98	.TP 8
99	.B v
100	Normally
101	.I ansitape
102	works relatively silently.
103	The
104	.B v
105	(verbose) option causes it to type
106	information about each file as it processes it.
107	.TP 8
108	.B b
109	The
110	.B b
111	option allows the user to select the blocksize to be used for the
112	tape.
113	By default,
114	.I ansitape
115	uses the maximum block size permitted by the ANSI standard, 2048.
116	Some systems will permit a much large block size, and if large
117	files are being put on the tape it may be advantageous to do so.
118	.I Ansitape
119	will take the next argument of the keyargs list as the blocksize for the tape.
120	Values below 18 or above 32k will be limited to that range.
121	The standard scale factors b=512 and k=1024 are accepted.
122	.PP
123	.I Ansitape
124	will not copy directories, character or block special files,
125	symbolic links, sockets, or binary executables.
126	Attempts to put these on tape will result in warnings, and they will
127	be skipped completely.
128	.SH FILES
129	/dev/rmt12
130	.br
131	.SH DIAGNOSTICS
132	A warning message will be generated when a record exceeds the maximum record
133	length and the affected file will be truncated.
134	.br
135	.SH BUGS
136	Ansitape quietly truncates names longer than 17 characters.
137	.br
138	ANSI 'f' format files can be read but not written.
139	.br
140	Multivolume tapes can not be handled.
141	.br