From ac1444578c6594c2e6b3bc9143cb939a40ff25fc Mon Sep 17 00:00:00 2001 From: Benno Schulenberg Date: Fri, 21 Apr 2017 11:27:12 +0200 Subject: [PATCH] docs: harmonize the nanorc man page and Info document a bit And make the strings after "start=" and "end=" more readable. --- doc/nano.texi | 26 +++++++++++++------------- doc/nanorc.5 | 14 +++++++------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/nano.texi b/doc/nano.texi index e4e34752..b1596b98 100644 --- a/doc/nano.texi +++ b/doc/nano.texi @@ -893,12 +893,12 @@ via the following commands in a nanorc file: @table @code -@item syntax "str" ["fileregex" @dots{}] -Defines a syntax named "str" which can be activated via the @code{-Y/--syntax} +@item syntax "name" ["fileregex" @dots{}] +Defines a syntax named "name" which can be activated via the @code{-Y/--syntax} command-line option, or will be automatically activated if the current filename matches the extended regular expression "fileregex". All subsequent @code{color}, @code{icolor}, @code{header} and other such -statements will apply to this "str" syntax until a new @code{syntax} +statements will apply to this "name" syntax until a new @code{syntax} command is encountered. The "none" syntax is reserved; specifying it on the command line is the @@ -947,26 +947,26 @@ terminal supports transparency, not specifying a "bgcolor" tells @code{nano} to attempt to use a transparent background. @item icolor fgcolor,bgcolor "regex" @dots{} -Same as above, except that the text matching is case insensitive. +Same as above, except that the matching is case insensitive. -@item color fgcolor,bgcolor start="sr" end="er" +@item color fgcolor,bgcolor start="fromrx" end="torx" Display all pieces of text whose start matches extended regular expression -"sr" and whose end matches extended regular expression "er" with foreground -color "fgcolor" and background color "bgcolor", at least one of which -must be specified. This means that, after an initial instance of "sr", -all text will be highlighted until the first instance of "er". +"fromrx" and whose end matches extended regular expression "torx" with +foreground color "fgcolor" and background color "bgcolor", at least one of +which must be specified. This means that, after an initial instance of +"fromrx", all text until the first instance of "torx" will be colored. This allows syntax highlighting to span multiple lines. -@item icolor fgcolor,bgcolor start="sr" end="er" -Same as above, except that the text matching is case insensitive. +@item icolor fgcolor,bgcolor start="fromrx" end="torx" +Same as above, except that the matching is case insensitive. @item include "syntaxfile" Read in self-contained color syntaxes from "syntaxfile". Note that "syntaxfile" may contain only the above commands, from @code{syntax} to @code{icolor}. -@item extendsyntax str directive [arg @dots{}] -Extend the syntax previously defined as str to include new information. +@item extendsyntax name directive [arg @dots{}] +Extend the syntax previously defined as "name" to include new information. This allows you to add a new @code{color}, @code{icolor}, @code{header}, @code{magic}, @code{comment}, @code{linter}, or @code{formatter} directive to an already defined syntax --- useful when you want to slightly improve a syntax defined diff --git a/doc/nanorc.5 b/doc/nanorc.5 index c4e6a19d..27a83489 100644 --- a/doc/nanorc.5 +++ b/doc/nanorc.5 @@ -346,19 +346,19 @@ foreground. If your terminal supports transparency, not specifying a background. .TP .B icolor \fIfgcolor\fR,\fIbgcolor\fR """\fIregex\fR""" ... -Same as above, except that the text matching is case insensitive. +Same as above, except that the matching is case insensitive. .TP -.BR color " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIsr\fR"" " end= """\fIer\fR"" +.BR color " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIfromrx\fR"" " end= """\fItorx\fR"" Display all pieces of text whose start matches extended regular expression -\fIsr\fP and whose end matches extended regular expression \fIer\fP with +\fIfromrx\fP and whose end matches extended regular expression \fItorx\fP with foreground color \fIfgcolor\fP and background color \fIbgcolor\fP, at least one of which must be specified. This means that, after an -initial instance of \fIsr\fP, all text will be highlighted until the -first instance of \fIer\fP. This allows syntax highlighting to span +initial instance of \fIfromrx\fP, all text until the first instance of +\fItorx\fP will be colored. This allows syntax highlighting to span multiple lines. .TP -.BR icolor " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIsr\fR"" " end= """\fIer\fR"" -Same as above, except that the text matching is case insensitive. +.BR icolor " \fIfgcolor\fR,\fIbgcolor\fR " start= """\fIfromrx\fR"" " end= """\fItorx\fR"" +Same as above, except that the matching is case insensitive. .TP .BR include " ""\fIsyntaxfile\fR""" Read in self-contained color syntaxes from \fIsyntaxfile\fP. Note that