Commit 79971a30 authored by Benno Schulenberg's avatar Benno Schulenberg
Browse files

docs: remove the mention of backslashes for the argument of 'comment'

Also remove the backslashes from the two syntaxes that contained them.

This completes the fix for https://savannah.gnu.org/bugs/?51370.
parent a7901dd1
Showing with 13 additions and 13 deletions
+13 -13
...@@ -933,14 +933,14 @@ file. This functionality only works when libmagic is installed on the ...@@ -933,14 +933,14 @@ file. This functionality only works when libmagic is installed on the
system and will be silently ignored otherwise. system and will be silently ignored otherwise.
@item comment "string" @item comment "string"
Use the given string for commenting and uncommenting lines. A vertical bar or Use the given string for commenting and uncommenting lines.
pipe character (@t{|}) designates bracket-style comments; for example, @t{"/*|*/"} for If the string contains a vertical bar or pipe character (@t{|}),
this designates bracket-style comments; for example, @t{"/*|*/"} for
CSS files. The characters before the pipe are prepended to the line and the CSS files. The characters before the pipe are prepended to the line and the
characters after the pipe are appended at the end of the line. If no pipe characters after the pipe are appended at the end of the line. If no pipe
character is present, the entire string is prepended; for example, @t{"#"} for character is present, the full string is prepended; for example, @t{"#"} for
Python files. If empty double quotes are specified, the comment/uncomment Python files. If empty double quotes are specified, the comment/uncomment
functions are disabled; for example, @t{""} for JSON. Backslashes and double quotes functions are disabled; for example, @t{""} for JSON.
should be escaped with a backslash; for example, @t{".\\\""} for man page source.
The default value is @t{"#"}. The default value is @t{"#"}.
@item color fgcolor,bgcolor "regex" @dots{} @item color fgcolor,bgcolor "regex" @dots{}
......
...@@ -329,14 +329,14 @@ functionality only works when \fBlibmagic\fP is installed on the ...@@ -329,14 +329,14 @@ functionality only works when \fBlibmagic\fP is installed on the
system and will be silently ignored otherwise. system and will be silently ignored otherwise.
.TP .TP
.BI comment " string" .BI comment " string"
Use the given string for commenting and uncommenting lines. A vertical bar or Use the given string for commenting and uncommenting lines.
pipe character (\fB|\fP) designates bracket-style comments; for example, "\fB/*|*/\fP" for If the string contains a vertical bar or pipe character (\fB|\fR),
this designates bracket-style comments; for example, "\fB/*|*/\fR" for
CSS files. The characters before the pipe are prepended to the line and the CSS files. The characters before the pipe are prepended to the line and the
characters after the pipe are appended at the end of the line. If no pipe characters after the pipe are appended at the end of the line. If no pipe
character is present, the entire string is prepended; for example, "\fB#\fP" for character is present, the full string is prepended; for example, "\fB#\fR"
Python files. If empty double quotes are specified, the comment/uncomment for Python files. If empty double quotes are specified, the comment/uncomment
function is disabled; for example, "" for JSON. Backslashes and double quotes function is disabled; for example, "" for JSON.
should be escaped with a backslash; for example, "\fB.\\\"\fP" for man page source.
The default value is "\fB#\fP". The default value is "\fB#\fP".
.TP .TP
.B color \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ... .B color \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ...
......
## Here is an example for groff. ## Here is an example for groff.
syntax "groff" "\.m[ems]$" "\.rof" "\.tmac$" "^tmac." syntax "groff" "\.m[ems]$" "\.rof" "\.tmac$" "^tmac."
comment ".\\\"" comment ".\""
# The argument of .ds or .nr # The argument of .ds or .nr
color cyan "^\.(ds|nr) [^[:space:]]*" color cyan "^\.(ds|nr) [^[:space:]]*"
......
...@@ -2,7 +2,7 @@ ...@@ -2,7 +2,7 @@
syntax "man" "\.[1-9]x?$" syntax "man" "\.[1-9]x?$"
magic "troff or preprocessor input text" magic "troff or preprocessor input text"
comment ".\\\"" comment ".\""
color green "\.(SH|SS|TH) .*$" color green "\.(SH|SS|TH) .*$"
color brightgreen "\.(SH|SS|TH) " "\.([HIT]P)" color brightgreen "\.(SH|SS|TH) " "\.([HIT]P)"
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment