[groff] 01/01: Update man page of gropdf to document \X calls.

[Deri James]

deri pushed a commit to branch master
in repository groff.

commit 14c4fd87810427f1240a18c69ef63414087de028
Author: Deri James <address@hidden>
Date:   Sun Dec 29 22:16:17 2019 +0000

    Update man page of gropdf to document \X calls.
    
    * src/devices/gropdf/gropdf.1.man: The calls 'pagname' and
      'switchtopage' (used by mom to relocate TOC) are documented,
      together with their convenience commands '.pdfpagename' and
      '.pdfswitchtopage'.
---
 ChangeLog                       |  9 +++++++++
 src/devices/gropdf/gropdf.1.man | 31 +++++++++++++++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/ChangeLog b/ChangeLog
index 90792bd..e5c11e1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,12 @@
+2019-12-29  Deri James  <address@hidden>
+
+       Update man page of gropdf to document \X calls.
+
+       * src/devices/gropdf/gropdf.1.man: The calls 'pagname' and
+         'switchtopage' (used by mom to relocate TOC) are documented,
+         together with their convenience commands '.pdfpagename' and
+         '.pdfswitchtopage'.
+
 2019-12-29  Ingo Schwarze  <address@hidden>
 
        Improve documentation of pic(1) regarding printf.
diff --git a/src/devices/gropdf/gropdf.1.man b/src/devices/gropdf/gropdf.1.man
index af64137..51dd312 100644
--- a/src/devices/gropdf/gropdf.1.man
+++ b/src/devices/gropdf/gropdf.1.man
@@ -881,6 +881,37 @@ respectively.
 These macros must only be used within page traps.)
 .
 .TP
+.BI "\[rs]X'pdf: pagename " name
+This gives the current page a
+.IR name .
+.IP
+There are two default names for any document which do not need to
+be declared
+.IR \[oq]top\[cq] " and " \[oq]bottom\[cq] .
+.IP
+The convenience command for this is
+.BR .pdfpagename .
+.
+.TP
+.BI "\[rs]X'pdf: switchtopage " "when name"
+Normally each new page is appended to the end of the document, this command
+allows following pages to be inserted at a
+.I \[oq]named\[cq]
+position within the document (see pagename command above).
+.I \[oq]when\[cq]
+can be either
+.IR \[oq]after\[cq] " or " \[oq]before\[cq] .
+If it is ommitted it defaults to
+.I \[oq]before\[cq].
+.IP
+The convenience command for this is
+.BR .pdfswitchtopage .
+It should be used at the end of the page before you want the switch to happen.
+.IP
+This allows pages such as a TOC to be moved to elsewhere in the document, but
+more esoteric uses are possible.
+.
+.TP
 .BR "\[rs]X'pdf: transition'" "feature mode duration dimension motion 
direction scale bool"
 where
 .IP