~nytpu/gemroff

80a9442c02d7dd82132713215a9ae5afe7c1bbe0 — nytpu a month ago 1435672
gemroff(5): escape all Gemroff markup listed

When using man-db (which uses groff(1) under-the-hood), some Gemroff markup is
interpreted as lower-level roff markup and breaks rendering.  Issue did not
occur with the bespoke man/mandoc parser in mandoc(1).

Reported by dzwdz
1 files changed, 39 insertions(+), 39 deletions(-)

M doc/gemroff.5
M doc/gemroff.5 => doc/gemroff.5 +39 -39
@@ 59,7 59,7 @@ more significant than a line break.
single line break
.It Nm =>
link
.It Nm .Im
.It Nm \&.Im
image
.It Nm #
level one header


@@ 85,37 85,37 @@ horizontal rule
.
.Ss Inline Markup
.Bl -tag -width .EmI -compact
.It Nm .Fn
.It Nm \&.Fn
single-line footnote
.It Nm .FnO
.It Nm \&.FnO
footnote block open
.It Nm .FnC
.It Nm \&.FnC
footnote block open
.It Nm .Lk
.It Nm \&.Lk
inline link
.It Nm .Em
.It Nm \&.Em
emphasis
.It Nm .EmI
.It Nm \&.EmI
important emphasis
.It Nm .T
.It Nm \&.T
title of an artistic work
.It Nm .Ts
.It Nm \&.Ts
title of a section of artistic work
.It Nm .St
.It Nm \&.St
strikethrough
.It Nm .C
.It Nm \&.C
inline code
.It Nm .Q
.It Nm \&.Q
single-line quote
.It Nm .Qo
.It Nm \&.Qo
quote block open
.It Nm .Qc
.It Nm \&.Qc
quote block close
.It Nm .P
.It Nm \&.P
single-line parenthetical
.It Nm .Po
.It Nm \&.Po
parenthetical block open
.It Nm .Pc
.It Nm \&.Pc
parenthetical block close
.It Nm ...
ellipsis


@@ 164,7 164,7 @@ otherwise the raw
will be displayed in its place.
.
.Ss Images
.Nm .Im
.Nm \&.Im
.Ar uri
.Op Ar alt text
.Pp


@@ 259,12 259,12 @@ of the markup line,
without being separated by a space.
.Pp
For example:
.Dl .P parenthetical text\ ,
.Dl \&.P parenthetical text\ ,
will be rendered as
.Dl (parenthetical text),
.Pp
Wheras:
.Dl .P parenthetical text,
.Dl \&.P parenthetical text,
will be rendered as
.Dl (parenthetical text,)
.Pp


@@ 313,7 313,7 @@ then it must be escaped with a second backslash
.Pq Ql \e\e .
.
.Ss Footnotes
.Nm .Fn
.Nm \&.Fn
.Op Ar text
.Op Ar abutting punctuation
.Pp


@@ 324,19 324,19 @@ as the footnote content,
either inline or in the designated footnote position.
.
.Ss Footnote Blocks
.Nm .FnO
.Nm \&.FnO
.sp 0
.Nm .FnC
.Nm \&.FnC
.Op Ar abutting punctuation
.Pp
Open and close a footnote block,
respectively.
Equivalent to
.Nm .Fn
.Nm \&.Fn
but allows using other markup inside a footnote.
.
.Ss Inline Links
.Nm .Lk
.Nm \&.Lk
.Ar uri
.Op Ar link title
.Op Ar abutting punctuation


@@ 348,7 348,7 @@ but
will be inserted into the current paragraph.
.
.Ss Emphasis
.Nm .Em
.Nm \&.Em
.Op Ar text
.Op Ar abutting punctuation
.Pp


@@ 357,7 357,7 @@ Emphasize the given
May be completely omitted in formats that don't support emphasis.
.
.Ss Important Emphasis
.Nm .EmI
.Nm \&.EmI
.Op Ar text
.Op Ar abutting punctuation
.Pp


@@ 367,7 367,7 @@ Even in plaintext formats that don't support emphasis,
enclose the text in an emphasis character.
.
.Ss Artistic Work Titles
.Nm .T
.Nm \&.T
.Op Ar title
.Op Ar abutting punctuation
.Pp


@@ 375,7 375,7 @@ The title of an artistic work.
Typically italicized where possible.
.
.Ss Artistic Work Section Titles
.Nm .Ts
.Nm \&.Ts
.Op Ar title
.Op Ar abutting punctuation
.Pp


@@ 384,7 384,7 @@ or the title of a smaller artistic work such as a short story.
Typically placed in double quotes.
.
.Ss Strikethroughs
.Nm .St
.Nm \&.St
.Op Ar text
.Op Ar abutting punctuation
.Pp


@@ 394,7 394,7 @@ In formats that don't support strikethrough,
enclose the text in a strikethrough character.
.
.Ss Inline Code
.Nm .C
.Nm \&.C
.Op Ar code
.Op Ar abutting punctuation
.Pp


@@ 402,7 402,7 @@ An inline preformatted block,
the text will be monospaced if possible or enclosed in inline code characters.
.
.Ss Quotes
.Nm .Q
.Nm \&.Q
.Op Ar text
.Op Ar abutting punctuation
.Pp


@@ 410,19 410,19 @@ A single-line quote,
will be enclosed in quotation marks.
.
.Ss Quote Blocks
.Nm .Qo
.Nm \&.Qo
.sp 0
.Nm .Qc
.Nm \&.Qc
.Op Ar abutting punctuation
.Pp
Open and close a quote block,
respectively.
Equivalent to
.Nm .Q
.Nm \&.Q
but allows using other markup inside a quotation.
.
.Ss Parentheticals
.Nm .P
.Nm \&.P
.Op Ar text
.Op Ar abutting punctuation
.Pp


@@ 430,15 430,15 @@ A single-line parenthetical,
will be enclosed in parenthesis.
.
.Ss Parenthetical Blocks
.Nm .Po
.Nm \&.Po
.sp 0
.Nm .Pc
.Nm \&.Pc
.Op Ar abutting punctuation
.Pp
Open and close a parenthetical block,
respectively.
Equivalent to
.Nm .P
.Nm \&.P
but allows using other markup inside a parenthetical.
.
.Ss Emdashes