Merge pull request #1351 from https://github.com/g-branden-robinson/NetHack into NetHack-3.7
This commit is contained in:
157
doc/dlb.6
157
doc/dlb.6
@@ -21,25 +21,53 @@
|
|||||||
dlb \- NetHack data librarian
|
dlb \- NetHack data librarian
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
.B dlb
|
.B dlb
|
||||||
{
|
.\" We'd use `RB` with 7 arguments, but Unix troff man(7) has a limit of
|
||||||
.B xct
|
.\" 6 arguments to its macros.
|
||||||
}
|
{\c
|
||||||
[
|
.BR c | t | x\c
|
||||||
.B vfIC
|
}\c
|
||||||
]
|
.RB [ v ]\c
|
||||||
arguments...
|
.RB [ C
|
||||||
[
|
.IR directory ]
|
||||||
.B files...
|
.RI [ file ]
|
||||||
]
|
\&.\|.\|.
|
||||||
.SH DESCRIPTION
|
|
||||||
.PP
|
.PP
|
||||||
|
.B dlb
|
||||||
|
{\c
|
||||||
|
.BR c | t | x\c
|
||||||
|
}\c
|
||||||
|
.RB [ v ]\c
|
||||||
|
.B I
|
||||||
|
.IR list-file
|
||||||
|
.PP
|
||||||
|
.B dlb
|
||||||
|
{\c
|
||||||
|
.BR c | t | x\c
|
||||||
|
}\c
|
||||||
|
.RB [ v ]\c
|
||||||
|
.RB [ f
|
||||||
|
.IR archive-file-name ]
|
||||||
|
.RI [ file ]
|
||||||
|
\&.\|.\|.
|
||||||
|
.SH DESCRIPTION
|
||||||
.I Dlb
|
.I Dlb
|
||||||
is a file archiving tool in the spirit (and tradition) of tar for
|
is a file archiving tool in the spirit (and tradition) of
|
||||||
NetHack version 3.1 and higher. It is used to maintain the
|
.IR tar (1)
|
||||||
archive files from which NetHack reads special level files and other
|
for
|
||||||
read-only information. Note that like tar the command and option
|
.IR nethack (6)
|
||||||
specifiers are specified as a continuous string and are followed
|
version 3.1 and higher.
|
||||||
by any arguments required in the same order as the option specifiers.
|
It is used to maintain the
|
||||||
|
archive files from which the game reads special level files and other
|
||||||
|
read-only information.
|
||||||
|
Note that like
|
||||||
|
.IR tar ,
|
||||||
|
the letters specifying the operation and options
|
||||||
|
are expressed as a continuous string.
|
||||||
|
Unlike
|
||||||
|
.IR tar ,
|
||||||
|
.I dlb
|
||||||
|
is configured with a default set of file names to process.
|
||||||
|
.ig
|
||||||
.PP
|
.PP
|
||||||
^?ALLDOCS
|
^?ALLDOCS
|
||||||
This facility is optional and may be excluded during NetHack
|
This facility is optional and may be excluded during NetHack
|
||||||
@@ -53,65 +81,74 @@ This facility is optional and was excluded from this NetHack
|
|||||||
configuration.
|
configuration.
|
||||||
^.
|
^.
|
||||||
^.
|
^.
|
||||||
.SH COMMANDS
|
..
|
||||||
The
|
.SS Operations
|
||||||
.B x
|
|
||||||
command causes
|
|
||||||
.I dlb
|
|
||||||
to extract the contents of the archive into the current directory.
|
|
||||||
.PP
|
|
||||||
The
|
|
||||||
.B c
|
.B c
|
||||||
command causes
|
causes
|
||||||
.I dlb
|
.I dlb
|
||||||
to create a new archive from files in the current directory.
|
to create a new archive from files in the current directory.
|
||||||
.PP
|
.PP
|
||||||
The
|
|
||||||
.B t
|
.B t
|
||||||
command lists the files in the archive.
|
lists the files in the archive.
|
||||||
.SH OPTIONS AND ARGUMENTS
|
.PP
|
||||||
.TP 12em
|
.B x
|
||||||
\fBv
|
causes
|
||||||
verbose output
|
.I dlb
|
||||||
.br
|
to extract the contents of the archive into the current directory.
|
||||||
.sp 1
|
.SH OPTIONS
|
||||||
|
.TP 13n \" "I list-file" + 2n
|
||||||
|
.BI "C " dir
|
||||||
|
Change directory to
|
||||||
|
.I dir
|
||||||
|
before trying to
|
||||||
|
read any files.
|
||||||
.TP
|
.TP
|
||||||
\fBf\fI\ archive
|
.BI "f " archive
|
||||||
specify the archive. Default if f not specified is
|
Read from or write to
|
||||||
LIBFILE (usually the nhdat file in the playground).
|
.I archive
|
||||||
.br
|
instead of LIBFILE
|
||||||
.sp 1
|
(usually the
|
||||||
|
.I nhdat
|
||||||
|
file in the playground).
|
||||||
.TP
|
.TP
|
||||||
\fBI\fI\ lfile
|
.BI "I " list-file
|
||||||
specify the file containing the list of files to
|
Read from
|
||||||
put in to or extract from the archive if no files are listed
|
.I list-file
|
||||||
on the command line. Default for archive creation if no files
|
the names of files to emplace within or extract from the archive.
|
||||||
are listed is LIBLISTFILE.
|
The default for archive creation is LIBLISTFILE.
|
||||||
.br
|
|
||||||
.sp 1
|
|
||||||
.TP
|
.TP
|
||||||
\fBC\fI\ dir
|
.B v
|
||||||
change directory. Changes directory before trying to
|
Operate verbosely.
|
||||||
read any files (including the archive and the lfile).
|
|
||||||
.br
|
|
||||||
.SH EXAMPLES
|
.SH EXAMPLES
|
||||||
Create the default archive from the default file list:
|
Create the default archive from the default file list:
|
||||||
.br
|
.RS
|
||||||
|
.EX
|
||||||
dlb c
|
dlb c
|
||||||
.sp 1
|
.EE
|
||||||
List the contents of the archive 'foo':
|
.RE
|
||||||
.br
|
|
||||||
dlb tf foo
|
|
||||||
.SH AUTHOR
|
|
||||||
.PP
|
.PP
|
||||||
|
List the contents of the archive
|
||||||
|
.IR foo :
|
||||||
|
.RS
|
||||||
|
.EX
|
||||||
|
dlb tf foo
|
||||||
|
.EE
|
||||||
|
.RE
|
||||||
|
.SH AUTHOR
|
||||||
Kenneth Lorber
|
Kenneth Lorber
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
.PP
|
.IR nethack (6),
|
||||||
nethack(6), tar(1)
|
.IR tar (1)
|
||||||
.SH BUGS
|
.SH BUGS
|
||||||
.PP
|
.IP \(bu 2n
|
||||||
Not a good tar emulation; - does not mean stdin or stdout.
|
Not a good
|
||||||
|
.I tar
|
||||||
|
emulation;
|
||||||
|
.B -
|
||||||
|
does not mean stdin or stdout.
|
||||||
|
.IP \(bu
|
||||||
Should include an optional compression facility.
|
Should include an optional compression facility.
|
||||||
|
.IP \(bu
|
||||||
Not all read-only files for NetHack can be read out of an archive;
|
Not all read-only files for NetHack can be read out of an archive;
|
||||||
examining the source is the only way to know which files can be.
|
examining the source is the only way to know which files can be.
|
||||||
.SH COPYRIGHT
|
.SH COPYRIGHT
|
||||||
|
|||||||
@@ -48,6 +48,7 @@ supplies a directory which is the NetHack playground.
|
|||||||
It overrides the value from NETHACKDIR, HACKDIR, or the directory
|
It overrides the value from NETHACKDIR, HACKDIR, or the directory
|
||||||
specified by the game administrator during compilation
|
specified by the game administrator during compilation
|
||||||
(usually /usr/games/lib/nethackdir).
|
(usually /usr/games/lib/nethackdir).
|
||||||
|
.ig
|
||||||
.PP
|
.PP
|
||||||
^?ALLDOCS
|
^?ALLDOCS
|
||||||
For recovery to be possible,
|
For recovery to be possible,
|
||||||
@@ -69,6 +70,7 @@ This configuration of
|
|||||||
was created without support for recovery.
|
was created without support for recovery.
|
||||||
^.
|
^.
|
||||||
^.
|
^.
|
||||||
|
..
|
||||||
NetHack normally writes out files for levels as the player leaves them,
|
NetHack normally writes out files for levels as the player leaves them,
|
||||||
so they will be ready for return visits.
|
so they will be ready for return visits.
|
||||||
When checkpointing, NetHack also writes out the level entered and
|
When checkpointing, NetHack also writes out the level entered and
|
||||||
|
|||||||
Reference in New Issue
Block a user