gbranden pushed a commit to branch master
in repository groff.
commit c8e956334e71a3e1ef216c61b7da8f0013f98ebe
Author: G. Branden Robinson <[email protected]>
AuthorDate: Wed Jul 8 23:28:25 2026 -0500
doc/ms.ms.in: Fix macro synopsis syntax.
* Set "option brackets" in roman, not bold.
* Arrange option brackets idiomatically. Multiple optional arguments
are represented like this:
foo [bar [baz]]
instead of like this:
foo [bar] [baz]
to make clear that a "baz" argument can be interpreted only if a "bar"
argument precedes it. This distinction is important when "bar" and
"baz" have different types or semantics.
* Use groff-style font selection escape sequences. This is not an AT&T
troff document.
* Use escaped newline to break painfully long input line.
---
doc/ms.ms.in | 9 +++++----
1 file changed, 5 insertions(+), 4 deletions(-)
diff --git a/doc/ms.ms.in b/doc/ms.ms.in
index 54f23a8b7..147702ba7 100644
--- a/doc/ms.ms.in
+++ b/doc/ms.ms.in
@@ -1331,7 +1331,7 @@ cb cb
lf(CR) lx .
Macro Description
_
-\&.NH [\f[I]depth\f[]] \fI\m[red][name]\m[]\fP T{
+\&.NH \f[R][\f[I]depth\f[] \m[red][\f[I]name\f[]]\m[]] T{
Set an automatically numbered heading.
.
.I ms
@@ -1507,7 +1507,7 @@ cb cb
lf(CR) lx .
Macro Description
_
-\&.SH [\f[I]depth\f[]] \fI\m[red][name]\m[]\fP T{
+\&.SH \f[R][\f[I]depth\f[] \m[red][\f[I]name\f[]]\m[]] T{
Set an unnumbered heading.
.
.I depth
@@ -4137,7 +4137,8 @@ cb cb
lf(CR) lx .
Macro Description
_
-\m[red].XR \fIname\fP [\fIafter\fP [\fIbefore\fP [\fIhotlink-text\fP]]]\m[]
T{
+\m[red].XR \f[I]name\f[] \f[R][\f[I]after\f[] [\f[I]before\f[] \
+[\f[I]hotlink-text\f[]]]]\m[] T{
The
.I name
parameter should match a
@@ -4171,7 +4172,7 @@ Which is initially set to
But you can change it.
T}
_
-\m[red].XM \fIname\fP [\fItext\fP]\m[] T{
+\m[red].XM \f[I]name\f[] [\f[I]text\f[]]\m[] T{
Mark a particular position in the document with a
.I name .
Any
_______________________________________________
groff-commit mailing list
[email protected]
https://lists.gnu.org/mailman/listinfo/groff-commit
