]> git.pld-linux.org Git - packages/tar.git/blob - tar-man-debian.patch
- updated
[packages/tar.git] / tar-man-debian.patch
1 --- tar-1.13.93.orig/debian/rmt.8
2 +++ tar-1.13.93/debian/rmt.8
3 @@ -0,0 +1,223 @@
4 +.\" Copyright (c) 1983, 1991, 1993
5 +.\"    The Regents of the University of California.  All rights reserved.
6 +.\"
7 +.\" Redistribution and use in source and binary forms, with or without
8 +.\" modification, are permitted provided that the following conditions
9 +.\" are met:
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.
22 +.\"
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
33 +.\" SUCH DAMAGE.
34 +.\"
35 +.\"     @(#)rmt.8      8.2 (Berkeley) 12/11/93
36 +.\"
37 +.Dd December 11, 1993
38 +.Dt RMT 8
39 +.Os BSD 4.2
40 +.Sh NAME
41 +.Nm rmt
42 +.Nd remote magtape protocol module
43 +.Sh SYNOPSIS
44 +.Nm rmt
45 +.Sh DESCRIPTION
46 +.Nm Rmt
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.
50 +.Nm Rmt
51 +is normally started up with an
52 +.Xr rexec 3
53 +or
54 +.Xr rcmd 3
55 +call or the
56 +.Xr rsh 1
57 +command.
58 +.Pp
59 +The 
60 +.Nm rmt
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
64 +.Tn ASCII
65 +and in
66 +one of two forms. 
67 +Successful commands have responses of:
68 +.Bd -filled -offset indent
69 +.Sm off
70 +.Sy A Ar number No \en
71 +.Sm on
72 +.Ed
73 +.Pp
74 +.Ar Number
75 +is an
76 +.Tn ASCII
77 +representation of a decimal number.
78 +Unsuccessful commands are responded to with:
79 +.Bd -filled -offset indent
80 +.Sm off
81 +.Xo Sy E Ar error-number
82 +.No \en Ar error-message
83 +.No \en
84 +.Xc
85 +.Sm on
86 +.Ed
87 +.Pp
88 +.Ar Error-number
89 +is one of the possible error
90 +numbers described in
91 +.Xr intro 2
92 +and
93 +.Ar error-message
94 +is the corresponding error string as printed
95 +from a call to
96 +.Xr perror 3 .
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
100 +.Ql \en
101 +indicates that a newline should be supplied:
102 +.Bl -tag -width Ds
103 +.Sm off
104 +.It Xo Sy \&O Ar device
105 +.No \en Ar mode No \en
106 +.Xc
107 +Open the specified 
108 +.Ar device
109 +using the indicated
110 +.Ar mode .
111 +.Ar Device
112 +is a full pathname and
113 +.Ar mode
114 +is an
115 +.Tn ASCII
116 +representation of a decimal
117 +number suitable for passing to
118 +.Xr open 2 .
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
122 +.Xc
123 +Close the currently open device.  The
124 +.Ar device
125 +specified is ignored.
126 +.It Xo Sy L
127 +.Ar offset No \en
128 +.Ar whence No \en
129 +.Xc
130 +.Sm on
131 +Perform an
132 +.Xr lseek 2
133 +operation using the specified parameters.
134 +The response value is that returned from the
135 +.Xr lseek
136 +call.
137 +.Sm off
138 +.It Sy W Ar count No \en
139 +.Sm on
140 +Write data onto the open device.
141 +.Nm Rmt
142 +reads
143 +.Ar count
144 +bytes from the connection, aborting if
145 +a premature end-of-file is encountered.
146 +The response value is that returned from
147 +the
148 +.Xr write 2
149 +call.
150 +.Sm off
151 +.It Sy R Ar count No \en
152 +.Sm on
153 +Read
154 +.Ar count
155 +bytes of data from the open device.
156 +If
157 +.Ar count
158 +exceeds the size of the data buffer (10 kilobytes), it is
159 +truncated to the data buffer size.
160 +.Nm rmt
161 +then performs the requested 
162 +.Xr read 2
163 +and responds with 
164 +.Sm off
165 +.Sy A Ar count-read No \en
166 +.Sm on
167 +if the read was
168 +successful; otherwise an error in the
169 +standard format is returned.  If the read
170 +was successful, the data read is then sent.
171 +.Sm off
172 +.It Xo Sy I Ar operation
173 +.No \en Ar count No \en
174 +.Xc
175 +.Sm on
176 +Perform a
177 +.Dv MTIOCOP
178 +.Xr ioctl 2
179 +command using the specified parameters.
180 +The parameters are interpreted as the
181 +.Tn ASCII
182 +representations of the decimal values
183 +to place in the 
184 +.Ar mt_op
185 +and
186 +.Ar mt_count
187 +fields of the structure used in the
188 +.Xr ioctl
189 +call.  The return value is the
190 +.Ar count
191 +parameter when the operation is successful.
192 +.It Sy S
193 +Return the status of the open device, as
194 +obtained with a
195 +.Dv MTIOCGET
196 +.Xr ioctl
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
200 +sent (in binary).
201 +.El
202 +.Sm on
203 +.Pp
204 +Any other command causes 
205 +.Nm rmt
206 +to exit.
207 +.Sh DIAGNOSTICS
208 +All responses are of the form described above.
209 +.Sh SEE ALSO
210 +.Xr tar 1 ,
211 +.Xr cpio 1 ,
212 +.Xr mt 1 ,
213 +.Xr rsh 1 ,
214 +.Xr rcmd 3 ,
215 +.Xr rexec 3 ,
216 +.Xr mtio 4 ,
217 +.Xr rdump 8 ,
218 +.Xr rrestore 8
219 +.Sh BUGS
220 +People should be discouraged from using this for a remote
221 +file access protocol.
222 +.Sh HISTORY
223 +The
224 +.Nm
225 +command appeared in
226 +.Bx 4.2 .
227 --- tar-1.13.93.orig/debian/tar.1
228 +++ tar-1.13.93/debian/tar.1
229 @@ -0,0 +1,313 @@
230 +.\" @(#)tar.1 1.11.1 93/19/22 PJV;
231 +.TH TAR 1 "22 September 1993"
232 +.SH NAME
233 +tar \- The GNU version of the tar archiving utility
234 +.SH SYNOPSIS
235 +.B tar
236 +[
237 +.B \-
238 +]
239 +.B A \-\-catenate \-\-concatenate \||\| c \-\-create \||\| d \-\-diff \-\-compare \||\| \-\-delete \||\| r \-\-append \||\| t \-\-list \||\| u \-\-update \||\| x \-\-extract \-\-get
240 +.TP
241 +.I [ options ]
242 +.TP
243 +.I filename1 [ filename2, ... filenameN ] 
244 +.TP
245 +.I directory1 [ directory2, ...directoryN ]
246 +.SH DESCRIPTION
247 +.LP
248 +This manual page documents the GNU version of
249 +.B tar
250 +, an archiving program designed to store and extract files from 
251 +an archive file known as a 
252 +.IR tarfile.
253 +A 
254 +.IR tarfile 
255 +may be made on a tape drive, however, it is also common
256 +to write a
257 +.IR tarfile
258 +to a normal file. 
259 +The first argument to 
260 +.B tar
261 +must be one of the options:
262 +.BR Acdrtux ,
263 +followed by any optional functions.
264 +The final arguments to 
265 +.B tar
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.
269 +.SH EXAMPLES
270 +.TP
271 +.B tar \-xvvf foo.tar
272 +extract foo.tar
273 +.TP
274 +.B tar \-xvvzf foo.tar.gz
275 +extract gzipped foo.tar.gz
276 +.TP
277 +.B tar \-cvvf foo.tar foo/
278 +tar contents of folder foo in foo.tar
279 +.SH "FUNCTION LETTERS"
280 +.TP
281 +.B One of the following options must be used:
282 +.TP
283 +.B \-A, \-\-catenate, \-\-concatenate
284 +append tar files to an archive
285 +.TP
286 +.B \-c, \-\-create     
287 +create a new archive
288 +.TP
289 +.B \-d, \-\-diff, \-\-compare
290 +find differences between archive and file system
291 +.TP
292 +.B \-\-delete          
293 +delete from the archive (not for use on mag tapes!)
294 +.TP
295 +.B \-r, \-\-append             
296 +append files to the end of an archive
297 +.TP
298 +.B \-t, \-\-list               
299 +list the contents of an archive
300 +.TP
301 +.B \-u, \-\-update             
302 +only append files that are newer than copy in archive
303 +.TP
304 +.B \-x, \-\-extract, \-\-get           
305 +extract files from an archive
306 +.SH "OTHER OPTIONS"
307 +.TP
308 +.B \-\-anchored        
309 +force exclusion patterns to match initial subsequences
310 +.TP
311 +.B \-\-atime\-preserve 
312 +don't change access times on dumped files
313 +.TP
314 +.B \-b, \-\-blocking\-factor N
315 +use record size of Nx512 bytes (default N=20)
316 +.TP
317 +.B \-B, \-\-read\-full\-records
318 +reblock as we read (for reading 4.2BSD pipes)
319 +.TP
320 +.B \-\-backup [TYPE]
321 +back up files instead of overwriting (TYPE=numbered, existing, simple)
322 +.TP 
323 +.B \-C, \-\-directory DIR      
324 +change to directory DIR
325 +.TP 
326 +.B \-\-checkpoint              
327 +print periodic checkpoints
328 +.TP
329 +.B \-\-exclude=PATTERN
330 +exclude files matching PATTERN
331 +.TP
332 +.B \-f, \-\-file [HOSTNAME:]F  
333 +use archive file or device F (default "\-", meaning stdin/stdout)
334 +.TP 
335 +.B \-F, \-\-info\-script F, \-\-new\-volume\-script F 
336 +run script at end of each tape (implies \-M)
337 +.TP
338 +.B \-\-force\-local            
339 +archive file is local even if it has a colon
340 +.TP
341 +.B \-G, \-\-incremental        
342 +create/list/extract old GNU-format incremental backup
343 +.TP
344 +.B \-g, \-\-listed\-incremental F 
345 +create/list/extract new GNU-format incremental backup
346 +.TP
347 +.B \-\-group G
348 +set group to G while adding files
349 +.TP 
350 +.B \-h, \-\-dereference        
351 +don't dump symlinks; dump the files they point to
352 +.TP
353 +.B \-\-help
354 +print help message
355 +.TP
356 +.B \-i, \-\-ignore\-zeros      
357 +ignore blocks of zeros in archive (normally mean EOF)
358 +.TP
359 +.B \-\-ignore\-case
360 +ignore case when excluding files
361 +.TP
362 +.B \-\-ignore\-failed\-read    
363 +don't exit with non-zero status on unreadable files
364 +.TP
365 +.B \-j, \-\-bzip2
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
370 +will work.
371 +.TP
372 +.B \-k, \-\-keep\-old\-files   
373 +keep existing files; don't overwrite them from archive
374 +.TP
375 +.B \-K, \-\-starting\-file F   
376 +begin at file F in the archive
377 +.TP
378 +.B \-l, \-\-one\-file\-system  
379 +stay in local file system when creating an archive
380 +.TP
381 +.B \-L, \-\-tape\-length N     
382 +change tapes after writing N*1024 bytes
383 +.TP
384 +.B \-m, \-\-touch
385 +don't extract file modified time
386 +.TP
387 +.B \-M, \-\-multi\-volume      
388 +create/list/extract multi-volume archive
389 +.TP
390 +.B \-\-mode M
391 +set permissions to M while adding files
392 +.TP
393 +.B \-N, \-\-after\-date DATE, \-\-newer DATE
394 +only store files newer than DATE
395 +.TP
396 +.B \-\-newer\-mtime DATE
397 +only store files whose contents have changed after DATE
398 +.TP
399 +.B \-\-no\-anchored
400 +allow exclusion patterns to match any substring (the default)
401 +.TP
402 +.B \-\-no\-ignore\-case
403 +match patterns case sensitively (the default)
404 +.TP
405 +.B \-\-no\-recursion
406 +do not recurse into subdirectories
407 +.TP
408 +.B \-\-no\-same\-owner
409 +extract files with owner set to current user (the default for non-root
410 +users)
411 +.TP
412 +.B \-\-no\-same\-permissions
413 +apply umask to extracted files (the default for non-root users)
414 +.TP
415 +.B \-\-no\-wildcards
416 +do not use wildcards when excluding files
417 +.TP
418 +.B \-\-no\-wildcards\-match\-slash
419 +don't let wildcards match "/" when excluding files
420 +.TP
421 +.B \-\-null
422 +for \-T, use "NUL" instead of newline as filename terminator
423 +.TP
424 +.B \-\-numeric\-owner
425 +always use numbers for user/group names
426 +.TP
427 +.B \-o, \-\-old\-archive, \-\-portability      
428 +write a V7 format archive, rather than ANSI format
429 +.TP
430 +.B \-O, \-\-to\-stdout         
431 +extract files to standard output
432 +.TP
433 +.B \-p, \-\-same\-permissions, \-\-preserve\-permissions 
434 +ignore umask when extracting files (the default for root)
435 +.TP
436 +.B \-P, \-\-absolute\-names
437 +don't strip leading `/'s from file names
438 +.TP
439 +.B \-\-posix
440 +create POSIX compliant archive
441 +.TP
442 +.B \-\-preserve                
443 +like \-p \-s
444 +.TP
445 +.B \-R, \-\-block\-number      
446 +show block number within archive with each message
447 +.TP
448 +.B \-\-record\-size SIZE
449 +use SIZE bytes per record
450 +.TP
451 +.B \-\-recursion
452 +recurse into directories (the default)
453 +.TP
454 +.B \-\-recursive\-unlink
455 +remove existing directories before extracting directories of the same
456 +name
457 +.TP 
458 +.B \-\-remove\-files           
459 +remove files after adding them to the archive
460 +.TP
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.
465 +.TP
466 +.B \-S, \-\-sparse             
467 +handle sparse files efficiently
468 +.TP
469 +.B \-s, \-\-same\-order, \-\-preserve\-order   
470 +list of names to extract is sorted to match archive
471 +.TP
472 +.B \-\-same\-owner             
473 +extract files with owner as specified in archive (the default for
474 +root)
475 +.TP
476 +.B \-\-show\-omitted\-dirs
477 +mention directories that are being skipped over
478 +.TP
479 +.B \-\-suffix SUFFIX
480 +append SUFFIX to make backup files (default ~)
481 +.TP 
482 +.B \-T, \-\-files\-from F      
483 +get names to extract or archive from file F
484 +.TP
485 +.B \-\-totals
486 +display total bytes written after creating an archive
487 +.TP
488 +.B \-\-totals          
489 +print total bytes written with \-\-create
490 +.TP
491 +.B \-U, \-\-unlink\-first
492 +unlink & recreate files instead of overwriting
493 +.TP
494 +.B \-\-use\-compress\-program PROG
495 +filter the archive through PROG (which must accept \-d)
496 +.TP
497 +.B \-v, \-\-verbose            
498 +verbosely list files processed
499 +.TP
500 +.B \-V, \-\-label NAME 
501 +create archive with volume name NAME
502 +.TP 
503 +.B \-\-version         
504 +print tar program version number
505 +.TP
506 +.B \-\-volno\-file F
507 +keep track of current volume (of a multi-volume archive) in F
508 +.TP
509 +.B \-w, \-\-interactive, \-\-confirmation      
510 +ask for confirmation for every action
511 +.TP
512 +.B \-W, \-\-verify             
513 +attempt to verify the archive after writing it
514 +.TP
515 +.B \-\-wildcards
516 +use wildcards when excluding files (the default)
517 +.TP
518 +.B \-\-wildcards\-match\-slash
519 +allow wildcards to match "/" (the default)
520 +.TP
521 +.B \-X, \-\-exclude\-from=FILE 
522 +exclude files matching patterns listed in FILE
523 +.TP
524 +.B \-Z, \-\-compress, \-\-uncompress           
525 +filter the archive through compress
526 +.TP 
527 +.B \-z, \-\-gzip, \-\-gunzip, \-\-ungzip               
528 +filter the archive through gzip
529 +.TP
530 +.B \-[0\-7][lmh]               
531 +specify drive and density
532 +.SH BUGS
533 +.LP
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.
539 +
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.
542 +
This page took 0.059336 seconds and 3 git commands to generate.