1 --- tar-1.13.93.orig/debian/rmt.8
2 +++ tar-1.13.93/debian/rmt.8
4 +.\" Copyright (c) 1983, 1991, 1993
5 +.\" The Regents of the University of California. All rights reserved.
7 +.\" Redistribution and use in source and binary forms, with or without
8 +.\" modification, are permitted provided that the following conditions
10 +.\" 1. Redistributions of source code must retain the above copyright
11 +.\" notice, this list of conditions and the following disclaimer.
12 +.\" 2. Redistributions in binary form must reproduce the above copyright
13 +.\" notice, this list of conditions and the following disclaimer in the
14 +.\" documentation and/or other materials provided with the distribution.
15 +.\" 3. All advertising materials mentioning features or use of this software
16 +.\" must display the following acknowledgement:
17 +.\" This product includes software developed by the University of
18 +.\" California, Berkeley and its contributors.
19 +.\" 4. Neither the name of the University nor the names of its contributors
20 +.\" may be used to endorse or promote products derived from this software
21 +.\" without specific prior written permission.
23 +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 +.\" @(#)rmt.8 8.2 (Berkeley) 12/11/93
37 +.Dd December 11, 1993
42 +.Nd remote magtape protocol module
47 +is a program used by tar, cpio, mt, and the remote dump and restore
48 +programs in manipulating a magnetic tape drive through an interprocess
49 +communication connection.
51 +is normally started up with an
61 +program accepts requests specific to the manipulation of
62 +magnetic tapes, performs the commands, then responds with
63 +a status indication. All responses are in
67 +Successful commands have responses of:
68 +.Bd -filled -offset indent
70 +.Sy A Ar number No \en
77 +representation of a decimal number.
78 +Unsuccessful commands are responded to with:
79 +.Bd -filled -offset indent
81 +.Xo Sy E Ar error-number
82 +.No \en Ar error-message
89 +is one of the possible error
94 +is the corresponding error string as printed
97 +The protocol is comprised of the
98 +following commands, which are sent as indicated - no spaces are supplied
99 +between the command and its arguments, or between its arguments, and
101 +indicates that a newline should be supplied:
104 +.It Xo Sy \&O Ar device
105 +.No \en Ar mode No \en
112 +is a full pathname and
116 +representation of a decimal
117 +number suitable for passing to
119 +If a device had already been opened, it is
120 +closed before a new open is performed.
121 +.It Xo Sy C Ar device No \en
123 +Close the currently open device. The
125 +specified is ignored.
133 +operation using the specified parameters.
134 +The response value is that returned from the
138 +.It Sy W Ar count No \en
140 +Write data onto the open device.
144 +bytes from the connection, aborting if
145 +a premature end-of-file is encountered.
146 +The response value is that returned from
151 +.It Sy R Ar count No \en
155 +bytes of data from the open device.
158 +exceeds the size of the data buffer (10 kilobytes), it is
159 +truncated to the data buffer size.
161 +then performs the requested
165 +.Sy A Ar count-read No \en
168 +successful; otherwise an error in the
169 +standard format is returned. If the read
170 +was successful, the data read is then sent.
172 +.It Xo Sy I Ar operation
173 +.No \en Ar count No \en
179 +command using the specified parameters.
180 +The parameters are interpreted as the
182 +representations of the decimal values
187 +fields of the structure used in the
189 +call. The return value is the
191 +parameter when the operation is successful.
193 +Return the status of the open device, as
197 +call. If the operation was successful,
198 +an ``ack'' is sent with the size of the
199 +status buffer, then the status buffer is
204 +Any other command causes
208 +All responses are of the form described above.
220 +People should be discouraged from using this for a remote
221 +file access protocol.
227 --- tar-1.13.93.orig/debian/tar.1
228 +++ tar-1.13.93/debian/tar.1
230 +.\" @(#)tar.1 1.11.1 93/19/22 PJV;
231 +.TH TAR 1 "22 September 1993"
233 +tar \- The GNU version of the tar archiving utility
239 +.B A \-\-catenate \-\-concatenate \||\| c \-\-create \||\| d \-\-diff \-\-compare \||\| \-\-delete \||\| r \-\-append \||\| t \-\-list \||\| u \-\-update \||\| x \-\-extract \-\-get
243 +.I filename1 [ filename2, ... filenameN ]
245 +.I directory1 [ directory2, ...directoryN ]
248 +This manual page documents the GNU version of
250 +, an archiving program designed to store and extract files from
251 +an archive file known as a
255 +may be made on a tape drive, however, it is also common
259 +The first argument to
261 +must be one of the options:
263 +followed by any optional functions.
264 +The final arguments to
266 +are the names of the files or directories which should be archived. The use
267 +of a directory name always implies that the subdirectories below should be
268 +included in the archive.
271 +.B tar \-xvvf foo.tar
274 +.B tar \-xvvzf foo.tar.gz
275 +extract gzipped foo.tar.gz
277 +.B tar \-cvvf foo.tar foo/
278 +tar contents of folder foo in foo.tar
279 +.SH "FUNCTION LETTERS"
281 +.B One of the following options must be used:
283 +.B \-A, \-\-catenate, \-\-concatenate
284 +append tar files to an archive
287 +create a new archive
289 +.B \-d, \-\-diff, \-\-compare
290 +find differences between archive and file system
293 +delete from the archive (not for use on mag tapes!)
296 +append files to the end of an archive
299 +list the contents of an archive
302 +only append files that are newer than copy in archive
304 +.B \-x, \-\-extract, \-\-get
305 +extract files from an archive
309 +force exclusion patterns to match initial subsequences
311 +.B \-\-atime\-preserve
312 +don't change access times on dumped files
314 +.B \-b, \-\-blocking\-factor N
315 +use record size of Nx512 bytes (default N=20)
317 +.B \-B, \-\-read\-full\-records
318 +reblock as we read (for reading 4.2BSD pipes)
320 +.B \-\-backup [TYPE]
321 +back up files instead of overwriting (TYPE=numbered, existing, simple)
323 +.B \-C, \-\-directory DIR
324 +change to directory DIR
327 +print periodic checkpoints
329 +.B \-\-exclude=PATTERN
330 +exclude files matching PATTERN
332 +.B \-f, \-\-file [HOSTNAME:]F
333 +use archive file or device F (default "\-", meaning stdin/stdout)
335 +.B \-F, \-\-info\-script F, \-\-new\-volume\-script F
336 +run script at end of each tape (implies \-M)
339 +archive file is local even if it has a colon
341 +.B \-G, \-\-incremental
342 +create/list/extract old GNU-format incremental backup
344 +.B \-g, \-\-listed\-incremental F
345 +create/list/extract new GNU-format incremental backup
348 +set group to G while adding files
350 +.B \-h, \-\-dereference
351 +don't dump symlinks; dump the files they point to
356 +.B \-i, \-\-ignore\-zeros
357 +ignore blocks of zeros in archive (normally mean EOF)
360 +ignore case when excluding files
362 +.B \-\-ignore\-failed\-read
363 +don't exit with non-zero status on unreadable files
366 +filter archive through bzip2, use to decompress .bz2 files.
367 +WARNING: some previous versions of tar used option \-I to
368 +filter through bzip2. When writing scripts, use \-\-bzip2
369 +instead of \-j so that both older and newer tar versions
372 +.B \-k, \-\-keep\-old\-files
373 +keep existing files; don't overwrite them from archive
375 +.B \-K, \-\-starting\-file F
376 +begin at file F in the archive
378 +.B \-l, \-\-one\-file\-system
379 +stay in local file system when creating an archive
381 +.B \-L, \-\-tape\-length N
382 +change tapes after writing N*1024 bytes
385 +don't extract file modified time
387 +.B \-M, \-\-multi\-volume
388 +create/list/extract multi-volume archive
391 +set permissions to M while adding files
393 +.B \-N, \-\-after\-date DATE, \-\-newer DATE
394 +only store files newer than DATE
396 +.B \-\-newer\-mtime DATE
397 +only store files whose contents have changed after DATE
400 +allow exclusion patterns to match any substring (the default)
402 +.B \-\-no\-ignore\-case
403 +match patterns case sensitively (the default)
405 +.B \-\-no\-recursion
406 +do not recurse into subdirectories
408 +.B \-\-no\-same\-owner
409 +extract files with owner set to current user (the default for non-root
412 +.B \-\-no\-same\-permissions
413 +apply umask to extracted files (the default for non-root users)
415 +.B \-\-no\-wildcards
416 +do not use wildcards when excluding files
418 +.B \-\-no\-wildcards\-match\-slash
419 +don't let wildcards match "/" when excluding files
422 +for \-T, use "NUL" instead of newline as filename terminator
424 +.B \-\-numeric\-owner
425 +always use numbers for user/group names
427 +.B \-o, \-\-old\-archive, \-\-portability
428 +write a V7 format archive, rather than ANSI format
430 +.B \-O, \-\-to\-stdout
431 +extract files to standard output
433 +.B \-p, \-\-same\-permissions, \-\-preserve\-permissions
434 +ignore umask when extracting files (the default for root)
436 +.B \-P, \-\-absolute\-names
437 +don't strip leading `/'s from file names
440 +create POSIX compliant archive
445 +.B \-R, \-\-block\-number
446 +show block number within archive with each message
448 +.B \-\-record\-size SIZE
449 +use SIZE bytes per record
452 +recurse into directories (the default)
454 +.B \-\-recursive\-unlink
455 +remove existing directories before extracting directories of the same
458 +.B \-\-remove\-files
459 +remove files after adding them to the archive
461 +.B \-\-rsh\-command=CMD
462 +Use remote COMMAND instead of `rsh'. This option exists so that
463 +people who use something other than the standard `rsh' (e.g., a
464 +Kerberized `rsh') can access a remote device.
467 +handle sparse files efficiently
469 +.B \-s, \-\-same\-order, \-\-preserve\-order
470 +list of names to extract is sorted to match archive
473 +extract files with owner as specified in archive (the default for
476 +.B \-\-show\-omitted\-dirs
477 +mention directories that are being skipped over
479 +.B \-\-suffix SUFFIX
480 +append SUFFIX to make backup files (default ~)
482 +.B \-T, \-\-files\-from F
483 +get names to extract or archive from file F
486 +display total bytes written after creating an archive
489 +print total bytes written with \-\-create
491 +.B \-U, \-\-unlink\-first
492 +unlink & recreate files instead of overwriting
494 +.B \-\-use\-compress\-program PROG
495 +filter the archive through PROG (which must accept \-d)
498 +verbosely list files processed
500 +.B \-V, \-\-label NAME
501 +create archive with volume name NAME
504 +print tar program version number
506 +.B \-\-volno\-file F
507 +keep track of current volume (of a multi-volume archive) in F
509 +.B \-w, \-\-interactive, \-\-confirmation
510 +ask for confirmation for every action
513 +attempt to verify the archive after writing it
516 +use wildcards when excluding files (the default)
518 +.B \-\-wildcards\-match\-slash
519 +allow wildcards to match "/" (the default)
521 +.B \-X, \-\-exclude\-from=FILE
522 +exclude files matching patterns listed in FILE
524 +.B \-Z, \-\-compress, \-\-uncompress
525 +filter the archive through compress
527 +.B \-z, \-\-gzip, \-\-gunzip, \-\-ungzip
528 +filter the archive through gzip
531 +specify drive and density
534 +The GNU folks, in general, abhor man pages, and create info documents instead.
535 +The maintainer of tar falls into this category. This man page is neither
536 +complete, nor current, and was included in the Debian Linux packaging of tar
537 +entirely to reduce the frequency with which the lack of a man page gets
538 +reported as a bug in our defect tracking system.
540 +If you really want to understand tar, then you should run info and read the
541 +tar info pages, or use the info mode in emacs.