From f47edf59c3d280fde03d456dc8b08e7bfa0d2665 Mon Sep 17 00:00:00 2001 From: nhmall Date: Thu, 28 May 2026 11:17:46 -0400 Subject: [PATCH] Guidebook update Make it clear that the *DIR options are not available on Unix. Related to discussion on GitHub Issue #1552 --- doc/Guidebook.mn | 14 +++++++++++++- doc/Guidebook.tex | 8 +++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/doc/Guidebook.mn b/doc/Guidebook.mn index b586163bd..2d16be04b 100644 --- a/doc/Guidebook.mn +++ b/doc/Guidebook.mn @@ -60,7 +60,7 @@ .ds f0 \*(vr .ds f1 \" empty .\"DO NOT REMOVE NH_DATESUB .ds f2 Date(%B %-d, %Y) -.ds f2 May 25, 2026 +.ds f2 May 28, 2026 . .\" A note on some special characters: .\" \(lq = left double quote @@ -3678,22 +3678,34 @@ OPTIONS=!legacy,autopickup,pickup_types:$\(dq=/!?+ .ft .ed .lp HACKDIR +[not availabe on Unix] +.br Default location of files NetHack needs. On Windows HACKDIR defaults to the location of the NetHack.exe or NetHackw.exe file so setting HACKDIR to override that is not usually necessary or recommended. .lp LEVELDIR +[not availabe on Unix] +.br The location that in-progress level files are stored. Defaults to HACKDIR, must be writable. .lp SAVEDIR +[not availabe on Unix] +.br The location where saved games are kept. Defaults to HACKDIR, must be writable. .lp BONESDIR +[not availabe on Unix] +.br The location that bones files are kept. Defaults to HACKDIR, must be writable. .lp LOCKDIR +[not availabe on Unix] +.br The location that file synchronization locks are stored. Defaults to HACKDIR, must be writable. .lp TROUBLEDIR +[not availabe on Unix] +.br The location that a record of game aborts and self-diagnosed game problems is kept. Defaults to HACKDIR, must be writable. .\" diff --git a/doc/Guidebook.tex b/doc/Guidebook.tex index 5ce42112e..9f12cee0b 100644 --- a/doc/Guidebook.tex +++ b/doc/Guidebook.tex @@ -25,7 +25,7 @@ \author{Original version - Eric S. Raymond\\ (Edited and expanded for 5.0.0 by Mike Stephenson and others)} %DO NOT REMOVE NH_DATESUB \date{Date(%B %-d, %Y)} -\date{May 25, 2026} +\date{May 28, 2026} \maketitle @@ -3980,27 +3980,33 @@ Example: %.lp \item[HACKDIR] +{[}Not available on Unix{}]\\ Default location of files \textit{NetHack} needs. On Windows HACKDIR defaults to the location of the \textit{NetHack.exe} or \textit{NetHackw.exe} file so setting HACKDIR to override that is not usually necessary or recommended. %.lp \item[LEVELDIR] +{[}Not available on Unix{}]\\ The location that in-progress level files are stored. Defaults to HACKDIR, must be writable. %.lp \item[SAVEDIR] +{[}Not available on Unix{}]\\ The location where saved games are kept. Defaults to HACKDIR, must be writable. %.lp \item[BONESDIR] +{[}Not available on Unix{}]\\ The location that bones files are kept. Defaults to HACKDIR, must be writable. %.lp \item[LOCKDIR] +{[}Not available on Unix{}]\\ The location that file synchronization locks are stored. Defaults to HACKDIR, must be writable. %.lp \item[TROUBLEDIR] +{[}Not available on Unix{}]\\ The location that a record of game aborts and self-diagnosed game problems is kept. Defaults to HACKDIR, must be writable. %