a6a32170ee
Content:
* Document that the command has a default file list.
* Demote "COMMANDS" section to "Operations" subsection. The former term
is (1) too easily confused with Unix commands and (2) not a widely
used section heading in man pages.
Style:
* Italicize command names.
* Italicize file names.
* Use idiomatic man page cross references.
* Present operation and option letters in alphabetical order.
* Render option descriptions as full sentences.
* Set bug list as a bulleted list.
Markup:
* Break input lines at sentence boundaries.
* Favor use of man(7) font selection and alternation macros over roff(7)
font selection escape sequences.
* Drop numerous extraneous paragraphing macro calls. See subsection
"Horizontal and vertical spacing" of groff_man(7).
* Replace use of *roff requests to break lines and vertically space with
calls of paragraphing macros, which is what they're for. Two things
the page author didn't know: `.sp 1` already implies a break, so the
preceding `.br` was redundant. `.sp 1` without an argument already
means to vertically space by 1 vee; that is, the "1" argument was
superfluous. It was a bad idea anyway because the default
inter-paragraph spacing in man(7) is not one vee, but 0.4v--this
matters when typesetting. It has also been the case since 1979.
* Use `RS` and `RE` macros instead of a literal tab to achieve a
relative inset. Use of the macros is more idiomatic.
* Use `EX` and `EE` to attempt to set the examples in a monospaced font
family. These are extensions and are silently ignored by formatters
that don't support them.
groff_man(7):
.EX
.EE Begin and end example. After .EX, filling is disabled and a
constant‐width (monospaced) font is selected. Calling .EE
enables filling and restores the previous font.
.EX and .EE are extensions introduced in Ninth Edition Unix.
Documenter’s Workbench, Heirloom Doctools, and Plan 9
troffs, and mandoc (since 1.12.2) also support them.
Solaris troff does not. See subsection “Use of extensions”
in groff_man_style(7).
* Kill off useless trailing space on input line.
157 lines
3.0 KiB
Groff
157 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
|
|
.IR tar (1)
|
|
for
|
|
.IR nethack (6)
|
|
version 3.1 and higher.
|
|
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
|
|
^?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.
|
|
^.
|
|
^.
|
|
..
|
|
.SS Operations
|
|
.B c
|
|
causes
|
|
.I dlb
|
|
to create a new archive from files in the current directory.
|
|
.PP
|
|
.B t
|
|
lists the files in the archive.
|
|
.PP
|
|
.B x
|
|
causes
|
|
.I dlb
|
|
to extract the contents of the archive into the current directory.
|
|
.SH OPTIONS
|
|
.TP 13n \" "I list-file" + 2n
|
|
.BI "C " dir
|
|
Change directory to
|
|
.I dir
|
|
before trying to
|
|
read any files.
|
|
.TP
|
|
.BI "f " archive
|
|
Read from or write to
|
|
.I archive
|
|
instead of LIBFILE
|
|
(usually the
|
|
.I nhdat
|
|
file in the playground).
|
|
.TP
|
|
.BI "I " list-file
|
|
Read from
|
|
.I list-file
|
|
the names of files to emplace within or extract from the archive.
|
|
The default for archive creation is LIBLISTFILE.
|
|
.TP
|
|
.B v
|
|
Operate verbosely.
|
|
.SH EXAMPLES
|
|
Create the default archive from the default file list:
|
|
.RS
|
|
.EX
|
|
dlb c
|
|
.EE
|
|
.RE
|
|
.PP
|
|
List the contents of the archive
|
|
.IR foo :
|
|
.RS
|
|
.EX
|
|
dlb tf foo
|
|
.EE
|
|
.RE
|
|
.SH AUTHOR
|
|
Kenneth Lorber
|
|
.SH "SEE ALSO"
|
|
.IR nethack (6),
|
|
.IR tar (1)
|
|
.SH BUGS
|
|
.IP \(bu 2n
|
|
Not a good
|
|
.I tar
|
|
emulation;
|
|
.B -
|
|
does not mean stdin or stdout.
|
|
.IP \(bu
|
|
Should include an optional compression facility.
|
|
.IP \(bu
|
|
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.
|