Docs for NetHack [nt]roff Guidebook macros.

diff --git a/doc/mn.7 b/doc/mn.7
index 281d05f700aa88f3c9597cf194c91aba748e5ddf..1d40edc2cd29c41f4efbf355f488b8b0df9737a3 100644 (file)
--- a/doc/mn.7
+++ b/doc/mn.7
@@ -1,3 +1,4 @@
+.\" $NHDT-Branch: NetHack-3.6.2 $:$NHDT-Revision: 1.0 $ $NHDT-Date: 1541298619 2018/11/04 02:30:19 $
 .TH MN 7 "News Version B2.11"
 .SH NAME
 mn \- text formatting macros for the news documentation
@@ -78,6 +79,8 @@ Matt Bishop
 .RI ( mab@riacs.arpa ,
 .IR ihnp4!ames!riacs!mab ,
 .IR decvax!decwrl!riacs!mab )
+.br
+Updated for versions 1.4-1.6 by The NetHack Development Team
 .SH REQUESTS
 .PP
 In the
@@ -228,6 +231,7 @@ _qc \*Z     mac     \-      \-      print name of control char; \*x is name,
                                in font 3, between <>, \*y after, \*z before
 _qp \*Z        mac     \-      \-      print char; same as _b
 _r     mac     \-      \-      switch to font 1
+rg     str     \-      \-      registered trademark symbol
 rq     str     ",''    \-      right double quotation marks
 s1     num     \-      i       current point size
 s2     num     \-      i       previous point size
@@ -258,6 +262,7 @@ ws  str     \-      \-      used to construct error message
 _ya    mac     \-      \-      same as calling _yf, _yi, _ys, _yv
 _yf    mac     \-      \-      restore fonts saved by _zf
 _yi    mac     \-      \-      restore indents saved by _zi
+Yr     str     \-      \-      current year
 _ys    mac     \-      \-      restore point sizes saved by _zs
 _yv    mac     \-      \-      restore vertical spacings saved by _zv
 _za    mac     \-      \-      same as calling _zf, _zi, _zs, _zv

diff --git a/doc/mnh.7 b/doc/mnh.7
new file mode 100644 (file)
index 0000000..daed162
--- /dev/null
+++ b/doc/mnh.7
@@ -0,0 +1,95 @@
+.\" $NHDT-Branch: NetHack-3.6.2 $:$NHDT-Revision: 1.0 $ $NHDT-Date: 1541298620 2018/11/04 02:30:20 $
+.TH MNH 7 NETHACK
+.SH NAME
+mnh \- additional text formatting macros for the NetHack Guidebook
+.SH SYNOPSIS
+.B "make Guidebook"
+.\"[ options ]  file  ...
+.\".br
+.\".B "troff  \-mn"
+.\"[ options ]  file  ...
+.SH DESCRIPTION
+.PP
+This package of
+.IR nroff (1)
+and
+.IR troff (1)
+macro definitions extends
+.IR tmac.n (7)
+for the NetHack Guidebook.  This document should be
+read as an addendum to the documentation for
+.IR tmac.n .
+.PP
+All \-mnh macros,
+diversions,
+string registers,
+and number registers are defined below.
+.SH FILES
+doc/tmac.nh
+.SH "SEE ALSO"
+mn(7)
+.SH AUTHOR
+Pat Rankin
+.SH REQUESTS
+.PP
+In the
+.I Note
+column,
+.I b
+means the request causes a break,
+and
+.I i
+means the macro,
+number register,
+string register,
+or diversion is internal and should not be used for anything.
+In the
+.I "What It Is"
+column,
+.IR div " means " diversion ,
+.IR mac " means " macro ,
+.IR num " means " "number register" ,
+and
+.IR str " means " "string register" .
+In the
+.I "Initial Value"
+column,
+a hyphen means no initial value is used,
+anything else is the initial value,
+and if two values are given,
+the first is for
+.I nroff
+and the second for
+.IR troff .
+.PP
+.if n .in 0
+.ds x \f2x\fP\|
+.ds y \f2y\fP\|
+.ds z \f2z\fP\|
+.ds X "\*x
+.ds Y "\*x \*y
+.ds Z "\*x \*y \*z
+.tr _.
+.ta \w'MacroNames'u +\w'WhatItIs'u +\w'InitialVal'u +\w'Note 'u
+.sp .3
+.nf
+Macro  What    Initial Note    \0 Explanation
+Name   It Is   Value
+.sp .3
+_BR    mac     \-      \-      hard line break with vertical padding inserted
+bR     num     \-      i
+_CC \*Y        mac     \-      \-      aligned one char key \*x with \fIshort\fP definition \*y
+CW     num     \-      i
+CX     num     \-      i
+CY     num     \-      i
+CZ     num     \-      i
+CZ     num     \-      i
+_ED    mac     \-      \-      ends .SD
+_PE    mac     \-      b       labelled paragraph end
+_PL \*X        mac     \-      b       labelled paragraph label is \*x
+_PS \*X        mac     \-      b       labelled paragraph start for label the width of \*x
+PX     num     \-      i
+PY     num     \-      i
+_SD \*X        mac     \-      \-      .sd with options c-center i-indent n-no indent
+SF     num     \-      i
+_UX    mac     \-      \-      .ux with updated trademark owner