groff-commit
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[groff] 16/17: [docs]: Update request synopses WRT leading '"'.


From: G. Branden Robinson
Subject: [groff] 16/17: [docs]: Update request synopses WRT leading '"'.
Date: Thu, 18 Jan 2024 14:27:51 -0500 (EST)

gbranden pushed a commit to branch master
in repository groff.

commit ac1297ac0921c3eddb99b9b069ec85007994b1d6
Author: G. Branden Robinson <g.branden.robinson@gmail.com>
AuthorDate: Thu Jan 18 11:33:52 2024 -0600

    [docs]: Update request synopses WRT leading '"'.
    
    Note this special syntax where it is supported, and where people can
    find it.
---
 doc/groff.texi       | 24 ++++++++++++------------
 man/groff_diff.7.man | 36 +++++++++++++++++++++++++-----------
 2 files changed, 37 insertions(+), 23 deletions(-)

diff --git a/doc/groff.texi b/doc/groff.texi
index e029e9bdd..27343dcd8 100644
--- a/doc/groff.texi
+++ b/doc/groff.texi
@@ -11265,10 +11265,10 @@ after the character can't be suppressed since the 
neighboring character
 on the right doesn't get examined.
 @endDefreq
 
-@DefreqList {char, c [@Var{contents}]}
-@DefreqItemx {fchar, c [@Var{contents}]}
-@DefreqItemx {fschar, f c [@Var{contents}]}
-@DefreqListEndx {schar, c [@Var{contents}]}
+@DefreqList {char, c [@code{"}][@Var{contents}]}
+@DefreqItemx {fchar, c [@code{"}][@Var{contents}]}
+@DefreqItemx {fschar, f c [@code{"}][@Var{contents}]}
+@DefreqListEndx {schar, c [@code{"}][@Var{contents}]}
 @cindex defining character (@code{char})
 @cindex defining fallback character (@code{fchar}, @code{fschar},@
 @code{schar})
@@ -12470,8 +12470,8 @@ sequence does not exist, it is defined as empty, 
nothing is
 interpolated, and a warning in category @samp{mac} is emitted.
 @xref{Warnings}, regarding the enablement and suppression of warnings.
 
-@DefreqList {ds, name [@Var{contents}]}
-@DefreqItemx {ds1, name [@Var{contents}]}
+@DefreqList {ds, name [@code{"}][@Var{contents}]}
+@DefreqItemx {ds1, name [@code{"}][@Var{contents}]}
 @DefescItemx {\\*, , n, }
 @DefescItem {\\*, (, nm, }
 @c XXX: Can't mark the parameters with @Var because @Var gets called
@@ -12615,8 +12615,8 @@ save} token is inserted at the beginning of 
@var{contents}, and a
 @endExample
 @endDefreq
 
-@DefreqList {as, name [@Var{contents}]}
-@DefreqListEndx {as1, name [@Var{contents}]}
+@DefreqList {as, name [@code{"}][@Var{contents}]}
+@DefreqListEndx {as1, name [@code{"}][@Var{contents}]}
 @cindex appending to a string (@code{as})
 @cindex string, appending (@code{as})
 The @code{as} request is similar to @code{ds} but appends @var{contents}
@@ -16374,8 +16374,8 @@ Give GNU @code{troff} or a front end program the 
@option{-U} option to
 enable unsafe mode.
 @endDefreq
 
-@DefreqList {write, stream data}
-@DefreqListEndx {writec, stream data}
+@DefreqList {write, stream [@code{"}]@Var{contents}}
+@DefreqListEndx {writec, stream [@code{"}]@Var{contents}}
 @cindex copy mode, and @code{write} request
 @cindex @code{write} request, and copy mode
 @cindex mode, copy, and @code{write} request
@@ -16948,8 +16948,8 @@ document.
 @endDefreq
 
 @DefreqList {tm, message}
-@DefreqItemx {tm1, message}
-@DefreqListEndx {tmc, message}
+@DefreqItemx {tm1, [@code{"}]message}
+@DefreqListEndx {tmc, [@code{"}]message}
 @cindex print to the standard error stream (@code{tm}, @code{tm1},@
 @code{tmc})
 @cindex standard error stream, write to (@code{tm}, @code{tm1},@
diff --git a/man/groff_diff.7.man b/man/groff_diff.7.man
index 9f3829dc9..22f4d8e0b 100644
--- a/man/groff_diff.7.man
+++ b/man/groff_diff.7.man
@@ -1865,7 +1865,8 @@ character on the right doesn't get examined.
 .
 .TP
 .BI .char\~ c\~\c
-.RI [ contents ]
+.RB [[ \[dq] ]\c
+.IR contents ]
 Define an ordinary or special
 .RI character\~ c
 as
@@ -2310,7 +2311,9 @@ requests.
 .
 .
 .TP
-.BI .ds1\~ "name contents"
+.BI .ds1\~ name\~\c
+.RB [[ \[dq] ]\c
+.IR contents ]
 As
 .BR ds ,
 but compatibility mode is disabled while
@@ -2409,7 +2412,8 @@ See
 .
 .TP
 .BI .fchar\~ c\~\c
-.RI [ contents ]
+.RB [[ \[dq] ]\c
+.IR contents ]
 Define fallback
 .RI character\~ c
 as
@@ -2440,7 +2444,8 @@ or the default if there is none.
 .
 .TP
 .BI .fschar\~ f\~c\~\c
-.RI [ contents ]
+.RB [[ \[dq] ]\c
+.IR contents ]
 Define fallback special
 .RI character\~ c
 for font\~\c
@@ -3358,7 +3363,8 @@ the request is ignored.
 .
 .TP
 .BI .schar\~ c\~\c
-.RI [ contents ]
+.RB [[ \[dq] ]\c
+.IR contents ]
 Define global fallback character
 .I c
 as
@@ -3586,7 +3592,9 @@ the increase in width is a linear function of the type 
size.
 .
 .
 .TP
-.BI .tm1\~ message
+.BR .tm1\~ [\c
+.RI [ \[dq] ]\c
+.IR contents ]
 As
 .BR tm ,
 but recognizes and strips a leading neutral double quote,
@@ -3829,7 +3837,9 @@ loop's flow of control.
 .
 .
 .TP
-.BI .write\~ stream\~contents
+.BI .write\~ stream\~\c
+.RB [[ \[dq] ]\c
+.IR contents ]
 Write
 .I contents
 to
@@ -3839,14 +3849,16 @@ which must previously have been the subject of an
 request,
 followed by a newline.
 .
-An initial neutral double quote in the second argument is stripped,
+A leading neutral double quote in the second argument is stripped,
 allowing embedded leading spaces in
 .IR contents ,
 which is read in copy mode until the end of the line.
 .
 .
 .TP
-.BI .writec\~ stream\~contents
+.BI .writec\~ stream\~\c
+.RB [[ \[dq] ]\c
+.IR contents ]
 As
 .BR write ,
 but does not append a newline to
@@ -3902,10 +3914,12 @@ this behavior is so anomalous that it must be 
considered a bug.
 .RI [ end-name ]
 .TQ
 .BI .ds\~ name\~\c
-.RI [ contents ]
+.RB [[ \[dq] ]\c
+.IR contents ]
 .TQ
 .BI .as\~ name\~\c
-.RI [ contents ]
+.RB [[ \[dq] ]\c
+.IR contents ]
 In compatibility mode,
 these requests behave similarly to
 .BR de1 ,



reply via email to

[Prev in Thread] Current Thread [Next in Thread]