Commit Graph

293 Commits

Author SHA1 Message Date
nhmall
b720c36b42 Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-10-27 19:29:50 -04:00
nhmall
aa0b973001 fix Guidebook.tex processing due to wrong brace used
[36] [37] [38] [39] [40] [41] [42] [43]
! Extra }, or forgotten \endgroup.
l.4602 ``{\tt up}'' and ``(\tt down}
                                    '' set the field attributes for when the...
2018-10-27 19:18:27 -04:00
PatR
bb62ab6fc1 another Guidebook update - mostly NETHACKOPTIONS
Move some 'roff macros from Guidebook.mn to new file tmac.nh.

Header for tmac.nh is not being updated, even after explicitly adding
it to .gitattributes.  I'm not sure what I've done wrong.  (I'm using
'git nhadd doc/' here rather than explicit 'git nhadd doc/tmac.nh'.)

In Guidebook.mn, change the ``setenv NETHACKOPTIONS'' example so that
it fits within one line in Guidebook.txt.  (I looked at 3.4.3's
edition of that file and the example went not just beyond the margin
of the formatted text but beyond 80 columns, so wrapped in an ugly
fashion.)  I had previously changed 'autoquiver' to 'color' to shorten
it, now have changed '!autopickup' to '!leg' to show an example of
truncated option name as well as shorten, and also 'fruit:papaya' to
'fruit:lime' to squeeze out the last two columns needed to fit within
the text margin while retaining 'name:Blue Meanie' as requested.
Guidebook.txt shows both NETHACKOPTIONS examples with indentation
suppressed, Guidebook.ps uses normal indentation (evidently using a
narrower font, even with \f(CR (constant-width Roman) to approximate
TeX's \tt, since the indented example fits fine and looks better).

Some Guidebook.tex catchup.  I suspect that lots of bits and bobs
don't match between Guidebook.mn and Guidebook.tex these days.
Particularly quoting and variant font (italics, bold, \tt) usage.
Also the recently added box around the sample screenshot.  This
modifies the screenshot to match Guidebook.mn's, reflecting change
in status field spacing by STATUS_HILITES.
2018-10-27 00:42:11 -07:00
nhmall
6a896bd9a4 Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-10-18 21:44:30 -04:00
PatR
f856837335 Guidebook.tex quoting
Change instances of 'C' and ``C'' to `C'.
Change a few double quotes, "..." to ``...''.
Remove some trailing spaces (for Guidebook.mn too).

One tweak in wording:  for #offer, ``use `m' to skip items on altar''
followed by ``you'll need to find an altar'' sounded strange.  Move the
``skip items on altar'' sentence after the ``need an altar'' sentence.
2018-10-18 14:37:41 -07:00
PatR
4cd983cb6f Guidebook.mn single quotes
Replace `C' and 'C' with \(oqC\(cq (open and close single quote).
For plain text output, the new form generates the first form.  Most
single quotes were using that, but there was quite a bit of C-style
char quoting that was somewhat inconsisent.

There are several text changes too, mostly small.  The few I can
remember are
  replacing several ``#twoweapon'' with `X';
  pets:  change 'cat' to 'kitten' and mention that horses are
    vegetartian where it claims that pets usually feed themselves;
  NETHACKOPTIONS:  add `bash' to the shells mentioned,
    describe `NETHACKOPTIONS=@filename' better,
    shorten the example (it's still too long for Guidebook.txt);
  Configuring Status Hilites:  expand the `behavior' descriptions
    to mention the value limits for percentage and absolute, and
    include post-3.6.1 '<=' and '>=' for them,
    add omitted fields `hunger' and `title' to text match.

I also changed a bunch of examples in the option configuation section
from bold font to constant-width Roman which more closely resembles
the \tt font in TeX.  Probably a whole bunch of other bold items
ought to follow suit.

Issues:
  title for section 9.3 (NETHACKOPTIONS) is too close to the sample
    config file at the end of section 9.2;
  as mentioned above, the sample ``setenv NETHACKOPTIONS foo'' is
    much too long for Guidebook.txt, and ``NETHACKOPTIONS=foo'' is
    slightly too long; they're ok in Guidebook.ps (assuming default
    page size);
  does `WIZKIT=~/wizkit.txt' actually work?  That's the example shown.
2018-10-17 05:22:36 -07:00
PatR
ebc89522ae a few Guidebook tweaks
I started out updating Guidebook.mn to use \(oq and \(cq for single
quotes but ended up including some new text.  I've separated that
part out (there are a few instances of altered quoting in the midst
of it--the separation wasn't 100%) to commit separately.

Add verbiage to "choosing race" and several commands:  f, s, S, t,
w, and ^X.

Change `E-' and `w-' to use minus sign instead of hyphen.  The TeX
edition uses \tt font for those which has the same effect of making
those dashes be more prominent.

Fix typo/thinko in `IX':  Guidebook.mn and Guidebook.txt said that
displayed inventory items whose bless/curse state is "known".
Guidebook.tex had it right, "unknown".
2018-10-16 15:18:09 -07:00
PatR
8612cc0f88 Guidebook.mn update
Replace ``foo'' with \(lqfoo\(rq (many instances) so that the
plain text Guidebook will use ".  Also a few `bar' with \(lqbar\(rq
(mostly `#enhance' and `#twoweapon') to be consistent with other
command names that all use double quotes.  And replace a few strings
in actual double quotes with corresponding \(lq or \(rq.

Replace command descriptions using ^X with \(haX to get the larger
circumflex character (aka 'hat') instead of the smaller circumflex
punctuation.  (Not noticeable with plain text output.)

Changed one DOS and a few MSDOS to MS-DOS to match the spelling in
the trademark line at the end.

Start each sentence on its own line for the paragraphs which were
being subjected to the above changes.

Also a much smaller subset for Guidebook.tex (not tested...).

Does not address the "wrapped to next line in middle of ' '" issue.
2018-10-14 12:58:59 -07:00
nhmall
5ceb53e6a6 Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-10-14 13:04:56 -04:00
PatR
f22d32316d fix #H7446 and #H7448 - Guidebook bits
\#H7448 - option 'dark_room' showed incorrect default value.

\#H7446 - persistence of objects section was missing a word in
its second paragraph.

Also, fix up some clumsy wording in the first paragraph of that
same section.
2018-10-14 02:02:41 -07:00
nhmall
232f016257 Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-10-06 12:53:41 -04:00
PatR
1110786ec2 change default for 'autodescribe' to 'on'
This was discussed two years ago then nothing happened.  Make
autodescribe for feedback when moving the cursor to pick something
default to on instead of off.
2018-10-01 15:08:33 -07:00
nhmall
141ddb98dc Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-09-28 20:01:08 -04:00
PatR
e0b7d2f5a9 monpolycontrol, wizdebug_*
Demote #monpolycontrol and #wizdebug_traveldisplay from commands to
simple boolean options.  The former has the same name, the latter
is called travel_debug.  Rename #wizdebug_bury to #wizbury; it
shouldn't matter that it goes away when compiled without DEBUG.

There are now five wizard-mode boolean options:  monpolycontrol,
sanity_check, and wizweight are documented in the Guidebook;
menu_tab_sep and travel_debug are commented out there.

Guidebook.mn has been tested; Guidebook.tex has not.
2018-09-26 18:40:13 -07:00
nhmall
a2d7722472 Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-09-26 17:38:39 -04:00
nhmall
22d69d2424 update tournament reference 2018-09-24 15:59:38 -04:00
nhmall
2ea332544b Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-09-20 18:45:08 -04:00
Mak Kolybabi
60ea2874ed Fix other spelling issues. 2018-09-19 21:46:07 -05:00
PatR
3eded06669 fix #H7156 - perm_invent
Bug report #H7156 listed three items, all relating to perm_invent:
1) it shouldn't persist across save/restore since restore might be
   on a system which doesn't have enough room to display it (report
   actually complained that config file setting was ignored when
   restoring old games, which is an expected side-effect for options
   that persist across save/restore);
2) permanent inventory wasn't updated when using scroll of charging;
3) attempts to update permanent inventory during restore could lead
   to crash if it tries to access shop cost for unpaid items.
Items (2) and (3) have already been fixed.  This fixes (1).

Replace 'flags.perm_invent' with a dummy flag, preserving save files
while removing it from flags.  Add 'iflags.perm_invent' to hold the
value of the perm_invent option.

The win32 files that are updated here haven't been tested.  Whichever
branch contains the curses interface needs to be updated; ditto for
any other pending/potential interfaces which support perm_invent.
2018-09-14 17:34:33 -07:00
nhmall
8dee5ff686 Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-08-31 07:15:26 -04:00
PatR
111cfa0ff4 Guidebook update
I noticed that the description of ^O still referred to the 3.6.0
behavior (either #wizwhere or #overview depending upon play mode)
rather than the 3.6.1 behavior (unconditional #overview).

While updating that I changed a bunch of "Wizard-mode" references
to "Debug mode" which is the proper end-user name.

I slightly expanded the descriptions of #wizdetect, #wizgenesis,
\#wizintrinsic, WIZKIT, and Debug mode, and removed at least one
out of date reference to debug mode being a conditional feature.

And for most of the stuff I was looking at, I changed the nroff
source to honor the roff guideline of having each sentence start
on its own line (and also the latex source to use those same line
breaks even though they don't need it).

Not done:  a lot of quoted single characters use 'c' instead of `c'
(pair of ticks rather than back-tick and normal tick).  One form
or the other should be changed so that they're all consistent.
I'm pretty this was mentioned the last time it was formatted for
the web site.

Guidebook.mn has been tested, Guidebook.tex has not.
2018-08-30 15:42:06 -07:00
Pasi Kallinen
9457fde9fc Document windowcolors option 2018-08-29 19:39:30 +03:00
nhmall
1886492a91 Merge branch 'NetHack-3.6.2-beta01' into NetHack-3.6.2 2018-05-28 08:46:17 -04:00
nhmall
15995375dd Guidebook date for merge verification 2018-05-28 08:45:35 -04:00
nhmall
d9975e5afc Revert "update some history"
This reverts commit 61bf743fb1.
2018-05-27 11:50:57 -04:00
nhmall
acfc1d1fe8 Revert "Guidebook.tex typo"
This reverts commit d9ce033915.
2018-05-27 11:50:36 -04:00
nhmall
afcbf56168 more Guidebook 2018-05-26 18:39:19 -04:00
nhmall
d9ce033915 Guidebook.tex typo 2018-05-26 18:27:29 -04:00
nhmall
61bf743fb1 update some history 2018-05-26 18:23:19 -04:00
nhmall
9cb9164ce5 update note of appreciation in Guidebooks (dat/history to follow) 2018-05-20 15:11:49 -04:00
nhmall
1e60a16565 sync date between two Guidebook files (.mn, .tex) 2018-05-16 23:26:07 -04:00
nhmall
2b66b5ecd1 bump version ID values 2018-05-16 23:06:44 -04:00
nhmall
9914250632 Guidebook.tex bit spotted in test pdf generation 2018-04-25 17:36:29 -04:00
nhmall
5101b9efb8 Update some dates and comment out BETA 2018-04-25 17:11:28 -04:00
nhmall
f6496a61f1 Apr23 Guidebook date bump 2018-04-23 21:31:28 -04:00
PatR
79c49eb86d Guidebook...
Refine the recently added short description about how monsters are
displayed on the map.
2018-04-23 16:08:57 -07:00
PatR
6f16a318a3 Guidebook update: map display of mons and objs
Mostly add a paragraph clarifying the classification of WONTFIX for
a reported bug ('I' unseen monster clobbers remembered object at the
location).  It felt like it needed a parallel paragraph for monsters.
2018-04-22 20:01:14 -07:00
nhmall
58eb1430b1 Guidebook.tex bit
also date bump
2018-04-20 19:00:35 -04:00
PatR
01abfa8c3d yet another Guidebook update
A couple of \e to \\ changes, a whole bunch of ^ to \(ha changes
(similar character but bigger so easier to see), ~ to \(ti (ditto),
and - to \- (first is a hyphen, second is a minus sign which is
bigger; see the difference for "- and | The walls of a room...").

As well as horizontal walls, open doors, top and bottom of swallow
and explode octagons, I changed command line switches -s, -X, and -D
to use minus sign.  I was unsure whether the umpteen M-C should be
changed too.  Since it was less work to leave them as-is, that's
what I did.  I also left ^C with smaller circumflex punctation
instead of changing to bigger circumflex character for same reason.

The [much smaller] Guidebook.tex changes need testing.

Not fixed:
I think the sentence "you can type 'nethack -s all' on most versions"
is very misleading.  Using 'versions' to refer to the various ports
rather than different releases is iffy, but my complaint is that
"typing something" sounds like an action you would perform while in
the game.  Access to a command line and figuring out how to invoke
nethack from there is probably not something where "most versions"
applies any more.  But I don't know how to rephrase that succinctly.
If I did, I would have just changed it....
2018-04-20 00:20:31 -07:00
nhmall
5895c18ab5 sync TeX Guidebook content bit with nroff Guidebook content 2018-04-19 22:27:26 -04:00
nhmall
9539dc40ce more Guidebook
Remove 3.6.0-specific preface.
Bump the date.
2018-04-19 22:10:46 -04:00
nhmall
3b86b29ce8 extraneous braces 2018-04-16 20:44:45 -04:00
nhmall
b5a623a6d7 fix Guidebook.tex creation
The Guidebook.tex band in it breaks the creation of Guidebook.tex.

    ! Not a letter.
    l.2701 \hyphenation{.
                     nethackrc}
    ?

For these simple one-time situations, just use \mbox{} to prevent
them from hyphenation instead.
2018-04-16 20:35:53 -04:00
nhmall
123dddebb6 Guidebook date bump 2018-04-16 19:55:04 -04:00
PatR
24c62868c4 more Guidebook.mn tweaks
The sample map was being rendered in a proportional-width font for
Guidebook.mn -> Guidebook.ps -> Guidebook.pdf so looked awful.  It
is quite hard to believe that no one ever noticed this.  I wasn't
sure how to force tty font, but it is straightforward to pick
constant-width variant of Roman which seems to be 'roff's universal
font.

Prevent ".nethackrc" from being hyphenated and split across lines.
Ditto for other file names in the same section even though they
hadn't been positioned in spots where they got split.  I put same
thing into Guidebook.tex but I don't know whether their embedded
dots will become a problem there.

Loads of unmatched double quotes were confusing Emacs' nroff-mode
(which unlike tex-mode for Guidebook.tex, wasn't being activated
by default for Guidebook.mn).  Supply missing closing quote for a
bunch of things, convert literal '"' to '\(dq' for ones that aren't
intended to have matching close quote.  And change a bunch of
instances of "text" to ``text'' for rendering as quoted strings.
(There are a lot of single-quoted characters 'c' which should
probably be `c' instead, but I haven't touched those.)

There were several '\e' to render the 'escape' character, but that
is something which can be changed at will.  Use '\\' to explicitly
show backslash instead.  Change several ' - ' and '--' to '\(em'
for M-sized dash.  Right now they all have <space>\(em<space> but
the spaces probably shouldn't be there.

Change instances of 'number_pad' to '.op number_pad' to have it
rendered as an option name.

Remove the obsolete sentence which said that "Elbereth" might be
conditionally excluded.  (This change also made in Guidebook.tex.)

Split some wide lines (wide in the source, not after rendering),
although this wasn't done exhaustively.  For the re-split lines,
put each sentence on its own line as suggested by 'roff' man page.
2018-04-16 16:29:01 -07:00
nhmall
68b1d0c7ba doc update 2018-04-14 19:01:15 -04:00
nhmall
a972554d7e more Guidebook symbols 2018-04-14 18:46:14 -04:00
nhmall
97a2995c28 spotted a typo in Guidebook.tex 2018-04-14 17:53:37 -04:00
nhmall
7945d517f4 more Guidebook 2018-04-14 17:34:05 -04:00
nhmall
fbb7aaaa63 bump the Guidebook date 2018-04-14 17:30:45 -04:00