0dc5d8c2f1
Follow Unix idioms and the guidelines presented in groff_man_style(7).[1] * Present multiple synopses since the command has multiple operation modes accessed via mutually inexpressible command letters. See the POSIX standard for copious precedent. * Stop implying that file name arguments are accepted alongside the `I` option; see line 236 of util/dlb_main.c. * Stop spacing around synopsis punctuation where unnecessary. * Set metasyntactic variables (parameters) in italics, not roman or bold. * Spell ellipsis idiomatically for pleasant typesetting. * Use `\c` escape sequence to force adjacency of tar-like option letters to the mandatory operation letter. * Use singular, not plural, for repeatable argument. The ellipsis does the grammatical work of pluralization for us. [1] Full disclosure: I wrote much of (the current form of) that man page.
139 lines
3.0 KiB
Groff
139 lines
3.0 KiB
Groff
.\" $NHDT-Branch: master $:$NHDT-Revision: 1.14 $ $NHDT-Date: 1735103831 2024/12/25 00:17:11 $
|
|
.\"DO NOT REMOVE NH_DATESUB .TH DLB 6 "Date(%-d %B %Y)" Project(uc)
|
|
.TH DLB 6 "25 December 2024" NETHACK
|
|
.\"DO NOT REMOVE NH_DATESUB .ds Nd Date(%Y)
|
|
.ds Nd 2024
|
|
.de NB
|
|
.ds Nb \\$2
|
|
..
|
|
.de NR
|
|
.ds Nr \\$2
|
|
..
|
|
.NB $NHDT-Branch: keni-gitset $
|
|
.NR $NHDT-Revision: 1.13 $
|
|
.\" groff and AT&T-descended troffs use different hyphenation patterns.
|
|
.\" Don't hyphenate the last word on a page or column, or
|
|
.\" before/after last/first 2 characters of a word.
|
|
.ie \n(.g .hy 12
|
|
.el .hy 14
|
|
.ds Na Kenneth Lorber
|
|
.SH NAME
|
|
dlb \- NetHack data librarian
|
|
.SH SYNOPSIS
|
|
.B dlb
|
|
.\" We'd use `RB` with 7 arguments, but Unix troff man(7) has a limit of
|
|
.\" 6 arguments to its macros.
|
|
{\c
|
|
.BR c | t | x\c
|
|
}\c
|
|
.RB [ v ]\c
|
|
.RB [ C
|
|
.IR directory ]
|
|
.RI [ file ]
|
|
\&.\|.\|.
|
|
.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
|
|
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.
|
|
.ig
|
|
.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
|
|
.TP 12m
|
|
\fBv
|
|
verbose output
|
|
.br
|
|
.sp 1
|
|
.TP
|
|
\fBf\fI\ archive
|
|
specify the archive. Default if f not specified is
|
|
LIBFILE (usually the nhdat file in the playground).
|
|
.br
|
|
.sp 1
|
|
.TP
|
|
\fBI\fI\ 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
|
|
.TP
|
|
\fBC\fI\ 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.
|