From 77631690a8ae25ca77477a8b3cdd08180b0d17d3 Mon Sep 17 00:00:00 2001 From: "G. Branden Robinson" Date: Tue, 4 Apr 2023 15:44:05 -0500 Subject: groff_mm(7): Recast pg header/footer macro descs. --- contrib/mm/groff_mm.7.man | 142 ++++++++++++++++++++++++++++------------------ 1 file changed, 87 insertions(+), 55 deletions(-) (limited to 'contrib/mm') diff --git a/contrib/mm/groff_mm.7.man b/contrib/mm/groff_mm.7.man index 5b0dc439e..391e586b3 100644 --- a/contrib/mm/groff_mm.7.man +++ b/contrib/mm/groff_mm.7.man @@ -1249,27 +1249,34 @@ as a heading. . . .TP -.BI EF\ \fR[\fParg\fR]\fP -Even-page footer, -printed just above the normal page footer on even pages. +.BR EF\~ [ \[dq]\|\[aq]\c +.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c +] +Define the even-page footer, +which is formatted just above the normal page footer on even-numbered +pages. . See .BR PF . . -.IP -This macro defines string +.B EF +defines the string .BR EOPef . . +. .TP -.BI EH\ \fR[\fParg\fR]\fP -Even-page header, -printed just below the normal page header on even pages. +.BR EH\~ [ \[dq]\|\[aq]\c +.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c +] +Define the even-page header, +which is formatted just below the normal page header on even-numbered +pages. . See .BR PH . . -.IP -This macro defines string +.B EH +defines the string .BR TPeh . . . @@ -2712,31 +2719,37 @@ l l. . . .TP -.BI OF\ \fR[\fParg\fR]\fP -Odd-page footer, a line printed just above the normal footer. +.BR OF\~ [ \[dq]\|\[aq]\c +.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c +] +Define the odd-page footer, +which is formatted just above the normal page footer on odd-numbered +pages. . See -.B EF -and .BR PF . . -.IP -This macro defines string +.B OF +defines the string .BR EOPof . . +. .TP -.BI OH\ \fR[\fParg\fR]\fP -Odd-page header, a line printed just below the normal header. +.BR OH\~ [ \[dq]\|\[aq]\c +.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c +] +Define the odd-page header, +which is formatted just below the normal page header on odd-numbered +pages. . See -.B EH -and .BR PH . . -.IP -This macro defines string +.B OH +defines the string .BR TPoh . . +. .TP .B OP Make sure that the following text is printed at the top of an @@ -2869,58 +2882,77 @@ see . . .TP -.BI PF\ \fR[\fParg\fR]\fP -Page footer. -.B PF -sets the line to be printed at the bottom of each page. +.BR PF\~ [ \[dq]\|\[aq]\c +.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c +] +Define the page footer. . -Empty by default. -. -See -.B PH -for the argument specification. +The footer is formatted at the bottom of each page; +the argument is otherwise as described in +.BR PH . . -.IP -This macro defines string +.B PF +defines the string .BR EOPf . . -.TP -.BI PH\ \fR[\fParg\fR]\fP -Page header, a line printed at the top of each page. +See +.BR EF , +.BR OF , +and +.BR EOP . . -The argument should be specified as . +.TP +.BR PH\~ [ \[dq]\|\[aq]\c +.IB left \[aq] center \[aq] right \[aq]\|\[dq]\c +] .RS -.IP -.RI \[dq]\[aq] left-part \[aq] center-part \[aq] right-part \[aq]\[dq] -.RE -. -.IP +Define the page header, +formatted at the top of each page, +as the argument, where -.IR left-part , -.IR center-part , +.IR left , +.IR center , and -.I right-part -are printed left-justified, centered, and right justified, respectively. +.I right +are aligned to the respective locations on the line. . -Within the argument to -.BR PH , -the character \[lq]%\[rq] is changed to the current page number. +A +.RB \[lq] % \[rq] +character appearing within +.I arg +is replaced by the current page number. +. +If the argument is absent, +no page header is set. . -The default argument is +The default page header is . .RS -.IP +.EX \[dq]\[aq]\[aq]\- % \-\[aq]\[aq]\[dq] +.EE .RE . -.IP -which gives the page number between two dashes. +which centers the page number between hyphens and formats nothing at the +upper left and right. . -.IP -This macro defines string +Header macros call +.B PX +(if defined) +after formatting the header. +. +.B PH +defines the string .BR TPh . . +See +.BR EH , +.BR OH , +and +.BR TP . +.RE +. . .TP .B PS -- cgit v1.2.1