git.gag.com Git - debian/dds2tar/blob - dds2index.man

   1 .TH dds2index 1 2.4 \" -*- nroff -*-
   2 .\"----------
   3 .SH NAME
   4 .\"----------
   5 dds2index \- tool to create an indexfile for the use of
   6 .\"----------
   7 .SH SYNOPSIS
   8 .\"----------
   9 .B dds2index
  10 [options]
  11 .\"----------
  12 .SH DESCRIPTION
  13 .\"----------
  14 .B dds2index
  15 creates an index file that is required by the file extraction utility
  16 .BR dds2tar(1) .
  17 It works on
  18 .B tar
  19 archives stored on dds tape devices (DAT).
  20 Since the file structure of the tape archives is
  21 used to extract the files, the archive must be an
  22 .B uncompressed tar
  23 archive. But compression by the transparent
  24 signal processor of the tape device is allowed.
  25 .PP
  26 The index created by
  27 .BR dds2index
  28 is written to
  29 .I stdout
  30 by default and should normally be stored on hard disk as
  31 .I indexfile
  32 for later use by
  33 .BR dds2tar(1) .
  34 .PP
  35 The default tape device to read from is
  36 .IR /dev/tape ,
  37 which may be overridden with the environment variable
  38 .BR TAPE ,
  39 which in turn may be overridden with the
  40 .BI -f\  device
  41 option. The device must be a SCSI tape device.
  42 .PP
  43 .\"----------
  44 .SH OPTIONS
  45 .\"----------
  46 .TP
  47 .BI -f\  devicefile
  48 device of the tape archive. Must be a character special file.
  49 .TP
  50 .BI -t\  indexfile
  51 write the index to
  52 .IR indexfile ,
  53 not to
  54 .IR stdout.
  55 .TP
  56 .BR -z , --compress
  57 write the index in (gzip) compressed mode.
  58 .TP
  59 .B --help
  60 print some screens of online help with examples through a pager
  61 and exit immediatley.
  62 .\"----------
  63 .SH OPTIONS you didn't really need
  64 .\"----------
  65 .TP
  66 .B -b, --block-size
  67 Set the maximal blocksize, dds2index can handle.
  68 .TP
  69 .TP
  70 .B --z, --no-compress
  71 Don't filter the archive file through gzip.
  72 .TP
  73 .BR -v , --verbose
  74 verbose mode. Print to
  75 .IR stderr
  76 what is going on.
  77 .TP
  78 .BR -h , --hash-mode
  79 Print a hash sign '#' to
  80 .I stderr
  81 for each MB read from tape.
  82 .TP
  83 .BR -V , --version
  84 Print the version number of
  85 .B dds2index
  86 to
  87 .I stderr
  88 and exit immediately.
  89 .\"----------
  90 .SH EXAMPLES
  91 .\"----------
  92 .RP
  93 Example of getting the index from the default tape /dev/tape
  94 and storing it in file archive.idx:
  95 .IP
  96 dds2index -v -t archive.idx
  97 .\"----------
  98 .SH WARNING
  99 .\"----------
 100 This program can only read records (tar is calling them tape blocks)
 101 up to 32 kbytes. A bigger buffer will cause problems with the Linux
 102 device driver.
 103 .\"----------
 104 .SH ENVIRONMENT
 105 .\"----------
 106 The environment variable
 107 .B TAPE
 108 overrides the default tape device /dev/tape.
 109 .\"----------
 110 .SH FILES
 111 .\"----------
 112 .TP 14
 113 /dev/tape
 114 default tape device file. Must be a character special file.
 115 .\"----------
 116 .SH "SEE ALSO"
 117 .\"----------
 118 dds2tar(1), mt(1), mt-dds(1), tar(1), gzip(1)
 119
 120 .\"----------
 121 .SH HISTORY
 122 .\"----------
 123 This program was created as a tool for
 124 .BR dds2tar(1) .
 125
 126 .\"----------
 127 .SH AUTHOR
 128 .\"----------
 129 J"org Weule (weule@cs.uni-duesseldorf.de), Phone +49 211 751409.
 130 This software is available at
 131 ftp.uni-duesseldorf.de:/pub/unix/apollo
 132