Files
nethack/doc/dlb.6
nhkeni 36e8d9e6fc nhgitset version 4
To update, run "perl DEVEL/nhgitset.pl"

Fixes:
- "nhcommit -a" has been fixed
- NHDT was hardwired in places
- no longer complain about a missing dat directory outside of the
    NetHack source tree
- make update of gitinfo atomic
- Replace some hardwired directory separators with OS-dependent constructs

Backwards Incompatibilities:
- NH_DATESUB's DATE() is now Date() to match the other variables
- MSYS2 requires an additional Perl package - the MSYS2 docs have
    been updated

New Help System:
- git nhhelp
   This command mirrors "git help" for nh* commands.
- See git nhhelp nhsub for general help on substitution variables

New Substitution Variables:
-Brev()
    An aBREViation of $PREFIX-Branch$:$PREFIX-Revision$ - this
    may help get line length under control in file headers.
-Assert(TYPE=VALUE)
    If TYPE does not match VALUE, do not substitute on this line.
    TYPE P checks VALUE against nethack.substprefix
-Project(arg)
    Returns nethack.projectname if there is no arg and an uppercase
    version if arg is uc.

Other New Features:
- Add nethack.projectname
- Documentation updates - see "git nhhelp nhsub"
- On checkout or merge of a branch, check for nhgitset version updates
  and provide an optional message to the user.
- Move NH_DATESUB substitutions here from cron job to keep dates in sync
- PREFIX-* keywords now available in NH_DATESUB templates
- Support use of nhgitset.pl from a different repo; note that update
  checks will be dependent on keeping the original source repo up-to-date
  and in the same location.
2024-11-11 09:15:49 -05:00

109 lines
2.5 KiB
Groff

.\" $NHDT-Branch: keni-gitset $:$NHDT-Revision: 1.13 $ $NHDT-Date: 1730949315 2024/11/06 22:15:15 $
.\"DO NOT REMOVE NH_DATESUB .TH DLB 6 "DATE(%-d %B %Y)" Project(uc)
.TH DLB 6 "DATE(%-d %B %Y)" NETHACK
.\"DO NOT REMOVE NH_DATESUB .ds Nd DATE(%Y)
.ds Nd DATE(%Y)
.de NB
.ds Nb \\$2
..
.de NR
.ds Nr \\$2
..
.NB $NHDT-Branch: keni-gitset $
.NR $NHDT-Revision: 1.13 $
.ds Na Kenneth Lorber
.SH NAME
dlb \- NetHack data librarian
.SH SYNOPSIS
.B dlb
{
.B xct
}
[
.B vfIC
]
arguments...
[
.B files...
]
.SH DESCRIPTION
.PP
.I Dlb
is a file archiving tool in the spirit (and tradition) of tar for
NetHack version 3.1 and higher. It is used to maintain the
archive files from which NetHack reads special level files and other
read-only information. Note that like tar the command and option
specifiers are specified as a continuous string and are followed
by any arguments required in the same order as the option specifiers.
.PP
^?ALLDOCS
This facility is optional and may be excluded during NetHack
configuration.
^:
^?DLB
This facility is optional but is included in this NetHack
configuration.
^:
This facility is optional and was excluded from this NetHack
configuration.
^.
^.
.SH COMMANDS
The
.B x
command causes
.I dlb
to extract the contents of the archive into the current directory.
.PP
The
.B c
command causes
.I dlb
to create a new archive from files in the current directory.
.PP
The
.B t
command lists the files in the archive.
.SH OPTIONS AND ARGUMENTS
.DT
.ta \w'f archive\ \ \ 'u
v verbose output
.br
.sp 1
f archive specify the archive. Default if f not specified is
LIBFILE (usually the nhdat file in the playground).
.br
.sp 1
I lfile specify the file containing the list of files to
put in to or extract from the archive if no files are listed
on the command line. Default for archive creation if no files
are listed is LIBLISTFILE.
.br
.sp 1
C dir change directory. Changes directory before trying to
read any files (including the archive and the lfile).
.br
.SH EXAMPLES
Create the default archive from the default file list:
.br
dlb c
.sp 1
List the contents of the archive 'foo':
.br
dlb tf foo
.SH AUTHOR
.PP
Kenneth Lorber
.SH "SEE ALSO"
.PP
nethack(6), tar(1)
.SH BUGS
.PP
Not a good tar emulation; - does not mean stdin or stdout.
Should include an optional compression facility.
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.
.SH COPYRIGHT
This file is Copyright (C) \*(Na, \*(Nd for version \*(Nb:\*(Nr.
NetHack may be freely redistributed. See license for details.