[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[groff] 01/01: Doc updates.
From: |
Peter Schaffter |
Subject: |
[groff] 01/01: Doc updates. |
Date: |
Wed, 5 Sep 2018 11:18:17 -0400 (EDT) |
PTPi pushed a commit to branch master
in repository groff.
commit 80ecbc42587ee8c67fc6496ee6c57faeb2cd0b2d
Author: Peter Schaffter <address@hidden>
Date: Wed Sep 5 11:17:51 2018 -0400
Doc updates.
---
contrib/mom/momdoc/headfootpage.html | 2 +-
contrib/mom/momdoc/images.html | 46 +++++++++++++++++++++++++++++++++---
contrib/mom/momdoc/macrolist.html | 14 +++++++++++
contrib/mom/momdoc/toc.html | 4 ++--
4 files changed, 60 insertions(+), 6 deletions(-)
diff --git a/contrib/mom/momdoc/headfootpage.html
b/contrib/mom/momdoc/headfootpage.html
index 607e255..8fb27c8 100644
--- a/contrib/mom/momdoc/headfootpage.html
+++ b/contrib/mom/momdoc/headfootpage.html
@@ -2177,7 +2177,7 @@ using PAGENUMBER_STYLE.*
<h4 id="pagenum-pos" class="docs" style="margin-top: 0em;">2. Page number
position</h4>
<div class="box-macro-args" style="margin-top: 1em;">
-Macro: <b>PAGENUM_POS</b> <kbd class="macro-args">TOP | BOTTOM LEFT
| CENTER | RIGHT</kbd>
+Macro: <b>PAGENUM_POS</b> <kbd class="macro-args">[ TOP | BOTTOM
] [ LEFT | CENTER | RIGHT ]</kbd>
</div>
<p>
diff --git a/contrib/mom/momdoc/images.html b/contrib/mom/momdoc/images.html
index 6df877e..e8fe844 100644
--- a/contrib/mom/momdoc/images.html
+++ b/contrib/mom/momdoc/images.html
@@ -79,6 +79,9 @@ FDL in the main directory of the groff source package.
<li><a href="#ps-pe">.PS / .PE macros and arguments</a></li>
<li><a href="#pic-text-style">PIC_TEXT_STYLE</a>—set parameters
for text used in diagrams</li>
</ul></li>
+ <li><a href="#grap">grap</a>
+ <ul style="margin-left: -1.25em;">
+ </ul></li>
<li><a href="#refer">refer</a></li>
</ul>
<li><a href="#captions-and-labels">Captions and labels</a>
@@ -1187,7 +1190,8 @@ preprocessor, <b>tbl</b>. If you are unfamiliar with
<b>tbl</b>, I
recommend downloading a copy of
<a href="http://plan9.bell-labs.com/10thEdMan/tbl.pdf">Tbl - A Program to
Format Tables</a>,
which, in addition to providing a thorough introduction, contains
-some fine examples.
+some fine examples. If you use <b>tbl</b>, you must pass groff or
+pdfmom the <b>-t</b> flag when you process the file.
</p>
<p>
@@ -1658,6 +1662,9 @@ preprocessor, <b>pic</b>. If you are unfamiliar with
<b>pic</b>, I
recommend downloading a copy of
<a href="http://www.kohala.com/start/troff/gpic.raymond.ps">Making Pictures
with GNU PIC</a>
which provides a thorough introduction and contains many examples.
+If you use <b>pic</b>, you must pass groff or pdfmom the <b>-p</b>
+flag when you process the file.
+
</p>
<p>
@@ -1728,7 +1735,7 @@ required)
[ SHORT_CAPTION "<short caption>" ]
<br/>
[ LABEL "<label>" ]
-</kbd>
+<br/>
[ TARGET "<name>" ]
</kbd>
<br/>
@@ -1917,6 +1924,37 @@ preprocessor itself, not groff or mom.
<div class="rule-medium"><hr/></div>
+<h3 id="grap" class="docs">grap support</h3>
+
+<p>
+Grap is a <b>pic</b> preprocessor for creating graphs. Grap
+usage is covered in the <kbd>grap(1)</kbd> manpage. Its mom
+implementation is the same as for <b>pic</b> except that instead of
+enclosing directives between
+<a href="#ps-pe">.PS / .PE</a>,
+they are enclosed between <b>.G1/.G2</b>. If you use <b>grap</b>,
+you must pass groff or pdfmom the <b>-G</b> flag when you process
+the file.
+
+</p>
+
+<p>
+<b>.G1</b> takes all the same arguments as
+<a href="#ps-pe">PS</a>
+with one exception: the argument <b>GRAP</b> must always be given to
+<b>.G1</b>. So, for example, a skeleton grap block raised 2 points
+and with a caption would be entered:
+<br/>
+<span class="pre-in-pp">
+ .G1 GRAP ADJUST +2p CAPTION "Graph caption"
+ <grap directives>
+ .G2
+</span>
+
+</p>
+
+<div class="rule-medium"><hr/></div>
+
<h3 id="eqn" class="docs">eqn support</h3>
<p>
@@ -1927,7 +1965,9 @@ the scope of this documentation, but is covered in the
manpage
Harding’s
<!--- edit me -->
<a href="http://www.zen89632.zen.co.uk/Groff/Eqn/eqnguide.pdf">A Guide to
Typesetting Mathematics Using GNU eqn</a>,
-which contains useful examples.
+which contains useful examples. If you use <b>eqn</b>, you must give groff or
+pdfmom the <b>-e</b> flag.
+
</p>
<div class="macro-id-overline">
diff --git a/contrib/mom/momdoc/macrolist.html
b/contrib/mom/momdoc/macrolist.html
index 5823d69..3ba8484 100644
--- a/contrib/mom/momdoc/macrolist.html
+++ b/contrib/mom/momdoc/macrolist.html
@@ -102,6 +102,7 @@ elsewhere in the documentation.
<li><a href="#qr-53">Images and graphics</a></li>
<li><a href="#qr-51">eqn support</a></li>
<li><a href="#qr-52">pic support</a></li>
+ <li><a href="#qr-58">grap support</a></li>
<li><a href="#qr-50">tbl support</a></li>
<li><a href="#qr-54">Captions and labels</a></li>
<li><a href="#qr-39">Bibliographic references</a></li>
@@ -901,6 +902,19 @@ elsewhere in the documentation.
<table class="quick-ref">
<tr>
+<th id="qr-58" class="quick-ref" colspan="2">
+<a href="images.html#grap">+++ grap support</a></th>
+</tr>
+<tr>
+<td><a href="images.html#grap">G1</a></td><td>-- begin a grap block</td>
+</tr>
+<tr>
+<td><a href="images.html#grap">G2</a></td><td>-- end a grap block</td>
+</tr>
+</table>
+
+<table class="quick-ref">
+<tr>
<th id="qr-50" class="quick-ref" colspan="2">
<a href="images.html#tbl">+++ tbl support</a></th>
</tr>
diff --git a/contrib/mom/momdoc/toc.html b/contrib/mom/momdoc/toc.html
index cea7756..c1d38fb 100644
--- a/contrib/mom/momdoc/toc.html
+++ b/contrib/mom/momdoc/toc.html
@@ -20,7 +20,7 @@ FDL in the main directory of the groff source package.
<head>
<meta http-equiv="content-type" content="text/html;charset=utf-8"/>
- <title>Mom, version 2.3 -- Table of Contents</title>
+ <title>Mom, version 2.3-a -- Table of Contents</title>
<link rel="stylesheet" type="text/css" href="stylesheet.css" />
</head>
@@ -31,7 +31,7 @@ FDL in the main directory of the groff source package.
<div class="page">
<div class="version">
- mom, version 2.3
+ mom, version 2.3-a
</div>
<h1 class="toc" style="margin-top: 9px;">Table of Contents</h1>
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [groff] 01/01: Doc updates.,
Peter Schaffter <=