doc/nethack.6: Revise "ENVIRONMENT" section

Explain meaning of stacked paragraph tags naming environment variables.

Drop call of deprecated man(7) `DT` macro and invocation of `ta` request
to set tab stops to attempt table-like layout.  (The latter made the
former nilpotent anyway.)  Replace this material with calls of tagged
paragraphing macro `TP` and groff man(7)'s `TQ` extension for setting
multiple tags with a paragraph.  The result takes up more screen lines,
but renders well with more formatters.

Set indentation of tagged paragraph using a constant numeric expression
to accommodate pseudo-roff formatters that don't implement arithmetic
evaluation.  (Some of these ignore _any_ indentation, regardless.)

Slightly recast descriptions of environment variables.

Set file name literals in italics.

Protect file and environment variable names from hyphenation.

Fixes:

an.tmac:doc/nethack.6:608: style: use of deprecated macro: .DT
This commit is contained in:
G. Branden Robinson
2026-05-06 04:39:57 -05:00
parent 6c9e8cb1c9
commit d2a49d4f8a
+62 -26
View File
@@ -605,34 +605,70 @@ In a perfect world,
.I paniclog
would remain empty.
.SH ENVIRONMENT
.DT
.ta \w'NETHACKDIR or HACKDIR\ \ \ 'u
USER or LOGNAME Your login name.
.br
HOME Your home directory.
.br
SHELL Your shell.
.br
TERM The type of your terminal.
.br
HACKPAGER or PAGER Replacement for default pager.
.br
MAIL Mailbox file.
.br
MAILREADER Replacement for default reader
.br
\ (probably /bin/mail or /usr/ucb/mail).
.br
NETHACKDIR or HACKDIR Playground.
.br
NETHACKOPTIONS String predefining several NetHack options.
In some cases,
.I NetHack
attempts to access multiple environment variables in sequence
(via
.IR getenv (3)
or similar)
to determine information.
.TP 16n \" "NETHACKOPTIONS" + 2n
.I USER
.TQ
.I
LOGNAME
Your login name.
.TP
.I HOME
Your home directory.
.TP
.I SHELL
Your login shell
(not necessarily the one running when you started
.IR NetHack ).
.TP
.I TERM
Your terminal type.
.TP
.I HACKPAGER
.TQ
.I PAGER
Replacement for default pager.
.TP
.I MAIL
Mailbox file.
.TP
.I MAILREADER
Replacement for default reader
(probably
.I /bin/\*:mail
or
.IR /usr/\*:ucb/\*:mail ).
.TP
.I NETHACKDIR
.TQ
.I HACKDIR
Playground.
.TP
.I NETHACKOPTIONS
Predefined
.I NetHack
options.
.PP
If the same option is specified in both NETHACKOPTIONS and .nethackrc,
the value assigned in NETHACKOPTIONS takes precedence.
If the same option is specified in both
.I \%NETHACKOPTIONS
and
.IR \%.nethackrc ,
the value assigned in
.I \%NETHACKOPTIONS
takes precedence.
.PP
SHOPTYPE and SPLEVTYPE can be used in debugging (wizard) mode.
.br
DEBUGFILES can be used if the program was built with 'DEBUG' enabled.
.I SHOPTYPE
and
.I \%SPLEVTYPE
can be used in debugging (wizard) mode.
.I \%DEBUGFILES
can be used if the program was built with 'DEBUG' enabled.
.SH "SEE ALSO"
.PP
recover(6)