Fix some issues found with fuzz testing
[aNetHack.git] / doc / dlb.6
blobe014d7343b976e1f5bef57dc8e0ef4486247c3df
1 .TH DLB 6 "28 Oct 1993"
2 .\" NetHack 3.6  dlb.6  $NHDT-Date: 1432512786 2015/05/25 00:13:06 $  $NHDT-Branch: master $:$NHDT-Revision: 1.6 $
3 .UC 4
4 .SH NAME
5 dlb \- NetHack data librarian
6 .SH SYNOPSIS
7 .B dlb
9 .B xct
12 .B vfIC
14 arguments...
16 .B files...
18 .SH DESCRIPTION
19 .PP
20 .I Dlb
21 is a file archiving tool in the spirit (and tradition) of tar for
22 NetHack version 3.1 and higher.  It is used to maintain the
23 archive files from which NetHack reads special level files and other
24 read-only information.  Note that like tar the command and option
25 specifiers are specified as a continuous string and are followed
26 by any arguments required in the same order as the option specifiers.
27 .PP
28 ^?ALLDOCS
29 This facility is optional and may be excluded during NetHack
30 configuration.
32 ^?DLB
33 This facility is optional but is included in this NetHack
34 configuration.
36 This facility is optional and was excluded from this NetHack
37 configuration.
40 .SH COMMANDS
41 The
42 .B x
43 command causes
44 .I dlb
45 to extract the contents of the archive into the current directory.
46 .PP
47 The
48 .B c
49 command causes
50 .I dlb
51 to create a new archive from files in the current directory.
52 .PP
53 The
54 .B t
55 command lists the files in the archive.
56 .SH OPTIONS AND ARGUMENTS
57 .DT
58 .ta \w'f archive\ \ \ 'u
59 v       verbose output
60 .br
61 .sp 1
62 f archive       specify the archive.  Default if f not specified is
63 LIBFILE (usually the nhdat file in the playground).
64 .br
65 .sp 1
66 I lfile specify the file containing the list of files to
67 put in to or extract from the archive if no files are listed
68 on the command line.  Default for archive creation if no files
69 are listed is LIBLISTFILE.
70 .br
71 .sp 1
72 C dir   change directory.  Changes directory before trying to
73 read any files (including the archive and the lfile).
74 .br
75 .SH EXAMPLES
76 Create the default archive from the default file list:
77 .br
78         dlb c
79 .sp 1
80 List the contents of the archive 'foo':
81 .br
82         dlb tf foo
83 .SH AUTHOR
84 .PP
85 Kenneth Lorber
86 .SH "SEE ALSO"
87 .PP
88 nethack(6), tar(1)
89 .SH BUGS
90 .PP
91 Not a good tar emulation; - does not mean stdin or stdout.
92 Should include an optional compression facility.
93 Not all read-only files for NetHack can be read out of an archive;
94 examining the source is the only way to know which files can be.