doc/dlb.6

   1 .TH DLB 6 "25 May 2015" NETHACK
   2 .de ND
   3 .ds Nd \\$3
   4 ..
   5 .de NB
   6 .ds Nb \\$2
   7 ..
   8 .de NR
   9 .ds Nr \\$2
  10 ..
  11 .ND $NHDT-Date: 1524689548 2018/04/25 20:52:28 $
  12 .NB $NHDT-Branch: NetHack-3.6.0 $
  13 .NR $NHDT-Revision: 1.7 $
  14 .ds Na Kenneth Lorber
  15 .SH NAME
  16 dlb \- NetHack data librarian
  17 .SH SYNOPSIS
  18 .B dlb
  19 {
  20 .B xct
  21 }
  22 [
  23 .B vfIC
  24 ]
  25 arguments...
  26 [
  27 .B files...
  28 ]
  29 .SH DESCRIPTION
  30 .PP
  31 .I Dlb
  32 is a file archiving tool in the spirit (and tradition) of tar for
  33 NetHack version 3.1 and higher.  It is used to maintain the
  34 archive files from which NetHack reads special level files and other
  35 read-only information.  Note that like tar the command and option
  36 specifiers are specified as a continuous string and are followed
  37 by any arguments required in the same order as the option specifiers.
  38 .PP
  39 ^?ALLDOCS
  40 This facility is optional and may be excluded during NetHack
  41 configuration.
  42 ^:
  43 ^?DLB
  44 This facility is optional but is included in this NetHack
  45 configuration.
  46 ^:
  47 This facility is optional and was excluded from this NetHack
  48 configuration.
  49 ^.
  50 ^.
  51 .SH COMMANDS
  52 The
  53 .B x
  54 command causes
  55 .I dlb
  56 to extract the contents of the archive into the current directory.
  57 .PP
  58 The
  59 .B c
  60 command causes
  61 .I dlb
  62 to create a new archive from files in the current directory.
  63 .PP
  64 The
  65 .B t
  66 command lists the files in the archive.
  67 .SH OPTIONS AND ARGUMENTS
  68 .DT
  69 .ta \w'f archive\ \ \ 'u
  70 v       verbose output
  71 .br
  72 .sp 1
  73 f archive       specify the archive.  Default if f not specified is
  74 LIBFILE (usually the nhdat file in the playground).
  75 .br
  76 .sp 1
  77 I lfile specify the file containing the list of files to
  78 put in to or extract from the archive if no files are listed
  79 on the command line.  Default for archive creation if no files
  80 are listed is LIBLISTFILE.
  81 .br
  82 .sp 1
  83 C dir   change directory.  Changes directory before trying to
  84 read any files (including the archive and the lfile).
  85 .br
  86 .SH EXAMPLES
  87 Create the default archive from the default file list:
  88 .br
  89         dlb c
  90 .sp 1
  91 List the contents of the archive 'foo':
  92 .br
  93         dlb tf foo
  94 .SH AUTHOR
  95 .PP
  96 Kenneth Lorber
  97 .SH "SEE ALSO"
  98 .PP
  99 nethack(6), tar(1)
 100 .SH BUGS
 101 .PP
 102 Not a good tar emulation; - does not mean stdin or stdout.
 103 Should include an optional compression facility.
 104 Not all read-only files for NetHack can be read out of an archive;
 105 examining the source is the only way to know which files can be.
 106 .SH COPYRIGHT
 107 This file is Copyright (C) \*(Na and was last modified \*(Nd (version
 108 \*(Nb:\*(Nr).
 109 NetHack may be freely redistributed.  See license for details.