doc/mnh.7

   1 .\" $NHDT-Branch: NetHack-3.6.2 $:$NHDT-Revision: 1.0 $ $NHDT-Date: 1541298620 2018/11/04 02:30:20 $
   2 .TH MNH 7 NETHACK
   3 .SH NAME
   4 mnh \- additional text formatting macros for the NetHack Guidebook
   5 .SH SYNOPSIS
   6 .B "make Guidebook"
   7 .\"[ options ]  file  ...
   8 .\".br
   9 .\".B "troff  \-mn"
  10 .\"[ options ]  file  ...
  11 .SH DESCRIPTION
  12 .PP
  13 This package of
  14 .IR nroff (1)
  15 and
  16 .IR troff (1)
  17 macro definitions extends
  18 .IR tmac.n (7)
  19 for the NetHack Guidebook.  This document should be
  20 read as an addendum to the documentation for
  21 .IR tmac.n .
  22 .PP
  23 All \-mnh macros,
  24 diversions,
  25 string registers,
  26 and number registers are defined below.
  27 .SH FILES
  28 doc/tmac.nh
  29 .SH "SEE ALSO"
  30 mn(7)
  31 .SH AUTHOR
  32 Pat Rankin
  33 .SH REQUESTS
  34 .PP
  35 In the
  36 .I Note
  37 column,
  38 .I b
  39 means the request causes a break,
  40 and
  41 .I i
  42 means the macro,
  43 number register,
  44 string register,
  45 or diversion is internal and should not be used for anything.
  46 In the
  47 .I "What It Is"
  48 column,
  49 .IR div " means " diversion ,
  50 .IR mac " means " macro ,
  51 .IR num " means " "number register" ,
  52 and
  53 .IR str " means " "string register" .
  54 In the
  55 .I "Initial Value"
  56 column,
  57 a hyphen means no initial value is used,
  58 anything else is the initial value,
  59 and if two values are given,
  60 the first is for
  61 .I nroff
  62 and the second for
  63 .IR troff .
  64 .PP
  65 .if n .in 0
  66 .ds x \f2x\fP\|
  67 .ds y \f2y\fP\|
  68 .ds z \f2z\fP\|
  69 .ds X "\*x
  70 .ds Y "\*x \*y
  71 .ds Z "\*x \*y \*z
  72 .tr _.
  73 .ta \w'MacroNames'u +\w'WhatItIs'u +\w'InitialVal'u +\w'Note 'u
  74 .sp .3
  75 .nf
  76 Macro   What    Initial Note    \0 Explanation
  77 Name    It Is   Value
  78 .sp .3
  79 nH      num     0       \-      avoid processing multiple times
  80 _BR     mac     \-      \-      hard line break with vertical padding inserted
  81 bR      num     \-      i
  82 _CC \*Y mac     \-      \-      aligned one char key \*x with \fIshort\fP definition \*y
  83 CW      num     \-      i
  84 CX      num     \-      i
  85 CY      num     \-      i
  86 CZ      num     \-      i
  87 CZ      num     \-      i
  88 _ED     mac     \-      \-      ends .SD
  89 _PE     mac     \-      b       labelled paragraph end
  90 _PL \*X mac     \-      b       labelled paragraph label is \*x
  91 _PS \*X mac     \-      b       labelled paragraph start for label the width of \*x
  92 PX      num     \-      i
  93 PY      num     \-      i
  94 _SD \*X mac     \-      \-      .sd with options c-center i-indent n-no indent
  95 SF      num     \-      i
  96 UR      mac     \-      \-      URL passthrough for HTML generator
  97 _UX     mac     \-      \-      .ux with updated trademark owner