[PATCH 23/31] docs: quote inline multiword literals

"G. Branden Robinson" <[email protected]> Thu, 23 Apr 2026 18:00:42 -0500
Newsgroups	gmane.editors.nano.devel
Message-ID	<20260423230042.pkfio7g4o7cledtm@illithid>
groff_man_style(7):
     • When and how should I use quotation marks?

       As noted above in subsection “Font style macros”, apply quotation
       marks to “brief specimens of literal text, such as article
       titles, inline examples, mentions of individual characters or
       short strings, and (sub)section headings in man pages”.  Multi‐
       word literals, such as Unix commands with arguments, when set
       inline (as opposed to displayed between EX and EE), should be
       quoted to ensure that the boundaries of the literal are clear
       even when the material is stripped of font styling by, for
       example, copy‐and‐paste operations. ...
---
 doc/nano.1   |  4 ++--
 doc/nanorc.5 | 48 ++++++++++++++++++++++++------------------------
 2 files changed, 26 insertions(+), 26 deletions(-)

diff --git a/doc/nano.1 b/doc/nano.1
index 631cefa1..19c84e82 100644
--- a/doc/nano.1
+++ b/doc/nano.1
@@ -34,7 +34,7 @@ .SH NOTICES
 (when the cursor approaches the edge), by just the amount needed,
 instead of scrolling only the current line by a large step.
 If you prefer the old behavior, you can use \fB\-\-solo\fR on the
-command line or \fBset solosidescroll\fR in your \fInanorc\fR.
+command line or \[lq]\fBset solosidescroll\fR\[rq] in your \fInanorc\fR.
 .P
 Also since version 9.0, keystrokes \fBM\-<\fR and \fBM\->\fR have
 been reassigned to the \fBscrollleft\fR and \fBscrollright\fR functions.
@@ -480,7 +480,7 @@ .SH EXIT STATUS
 .SH NOTES
 Suspension is enabled by default, reachable via \fB\[ha]T\[ha]Z\fR.
 (If you want a plain \fB\[ha]Z\fR to suspend \fBnano\fR, add
-\fBbind \[ha]Z suspend main\fR to your \fInanorc\fR.)
+\[lq]\fBbind \[ha]Z suspend main\fR\[rq] to your \fInanorc\fR.)
 .P
 At a Yes-No prompt, \fB\[ha]Y\fR can be used for \[lq]Yes\[rq], \fB\[ha]N\fR for \[lq]No\[rq],
 and \fB\[ha]A\fR for \[lq]All\[rq].
diff --git a/doc/nanorc.5 b/doc/nanorc.5
index dd527abe..1164ad42 100644
--- a/doc/nanorc.5
+++ b/doc/nanorc.5
@@ -38,7 +38,7 @@ .SH NOTICES
 (when the cursor approaches the edge), by just the amount needed,
 instead of scrolling only the current line by a large step.
 If you prefer the old behavior, you can use \fB\-\-solo\fR on the
-command line or \fBset solosidescroll\fR in your \fInanorc\fR.
+command line or \[lq]\fBset solosidescroll\fR\[rq] in your \fInanorc\fR.
 .P
 Also since version 9.0, keystrokes \fBM\-<\fR and \fBM\->\fR have
 been reassigned to the \fBscrollleft\fR and \fBscrollright\fR functions.
@@ -128,12 +128,12 @@ .SH OPTIONS
 .BI "set brackets \[dq]" characters \[dq]
 Set the characters treated as closing brackets when justifying
 paragraphs.  This may not include blank characters.  Only closing
-punctuation (see \fBset punct\fR), optionally followed by the specified
+punctuation (see \[lq]\fBset punct\fR\[rq]), optionally followed by the specified
 closing brackets, can end sentences.  The default value is \[lq]\fB\[dq]')>]}\fR\[rq].
 .TP
 .B set breaklonglines
 Automatically hard-wrap the current line when it becomes overlong \[em]
-that is: when it becomes wider than the value given with \fBset fill\fR
+that is: when it becomes wider than the value given with \[lq]\fBset fill\fR\[rq]
 (which defaults to the width of the terminal minus eight).
 .TP
 .B set casesensitive
@@ -162,7 +162,7 @@ .SH OPTIONS
 .B set errorcolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the status bar when an error message is displayed.
 The default value is \fBbold,white,red\fR.
-See \fBset titlecolor\fR for valid color names.
+See \[lq]\fBset titlecolor\fR\[rq] for valid color names.
 .TP
 .B set fill \fInumber\fR
 Set the target width for justifying and automatic hard-wrapping at this
@@ -174,11 +174,11 @@ .SH OPTIONS
 .B set functioncolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the concise function descriptions
 in the two help lines at the bottom of the screen.
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set guidestripe \fInumber
 Draw a vertical stripe at the given column, to help judge the width of the
-text.  (The color of the stripe can be changed with \fBset stripecolor\fR.)
+text.  (The color of the stripe can be changed with \[lq]\fBset stripecolor\fR\[rq].)
 .TP
 .B set historylog
 Save the last hundred search strings and replacement strings and
@@ -195,7 +195,7 @@ .SH OPTIONS
 .B set keycolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the shortcut key combos
 in the two help lines at the bottom of the screen.
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set linenumbers
 Display line numbers to the left of the text area.
@@ -223,20 +223,20 @@ .SH OPTIONS
 on the left, followed by an asterisk if the buffer has been modified.
 On the right are displayed the current line and column number, the
 code of the character under the cursor (in Unicode format: U+xxxx),
-the same flags as are shown by \fBset stateflags\fR, and a percentage
+the same flags as are shown by \[lq]\fBset stateflags\fR\[rq], and a percentage
 that expresses how far the cursor is into the file (linewise).
 When a file is loaded or saved, and also when switching between buffers,
 the number of lines in the buffer is displayed after the filename.
 This number is cleared upon the next keystroke, or replaced with an
 [i/n] counter when multiple buffers are open.
 The line plus column numbers and the character code are displayed only when
-\fBset constantshow\fR is used, and can be toggled on and off with \fBM\-C\fR.
-The state flags are displayed only when \fBset stateflags\fR is used.
+\[lq]\fBset constantshow\fR\[rq] is used, and can be toggled on and off with \fBM\-C\fR.
+The state flags are displayed only when \[lq]\fBset stateflags\fR\[rq] is used.
 .TP
 .B set minicolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the mini bar.
 (When this option is not specified, the colors of the title bar are used.)
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set mouse
 Enable mouse support, if available for your system.  When enabled,
@@ -260,11 +260,11 @@ .SH OPTIONS
 .TP
 .B set nowrap
 Deprecated option since it has become the default setting.
-When needed, use \fBunset breaklonglines\fR instead.
+When needed, use \[lq]\fBunset breaklonglines\fR\[rq] instead.
 .TP
 .B set numbercolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for line numbers.
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set operatingdir \fIdirectory\fR
 At startup, make \fBnano\fR change to the given \fIdirectory\fR, and allow
@@ -281,13 +281,13 @@ .SH OPTIONS
 .B set promptcolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the prompt bar.
 (When this option is not specified, the colors of the title bar are used.)
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .BI "set punct \[dq]" characters \[dq]
 Set the characters treated as closing punctuation when justifying
 paragraphs.  This may not include blank characters.  Only the
 specified closing punctuation, optionally followed by closing brackets
-(see \fBset brackets\fR), can end sentences.  The default value is \[lq]\fB!.?\fR\[rq].
+(see \[lq]\fBset brackets\fR)\[rq], can end sentences.  The default value is \[lq]\fB!.?\fR\[rq].
 .TP
 .B set quickblank
 Make status-bar messages disappear after 1 keystroke instead of after 20.
@@ -325,11 +325,11 @@ .SH OPTIONS
 .TP
 .B set scrollercolor \fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the indicator alias \[lq]scrollbar\[rq].
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set selectedcolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for selected text.
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set showcursor
 Put the cursor on the highlighted item in the file browser, and show
@@ -345,7 +345,7 @@ .SH OPTIONS
 .B set softwrap
 Display lines that exceed the screen's width over multiple screen lines.
 (You can make this soft-wrapping occur at whitespace instead of rudely at
-the screen's edge, by using also \fBset atblanks\fR.)
+the screen's edge, by using also \[lq]\fBset atblanks\fR\[rq].)
 .TP
 .B set solosidescroll
 When the cursor approaches the right edge of the edit window, scroll only the
@@ -362,7 +362,7 @@ .SH OPTIONS
 .B set spotlightcolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for highlighting a search match.
 The default value is \fBblack,\%lightyellow\fR.
-See \fBset titlecolor\fR for valid color names.
+See \[lq]\fBset titlecolor\fR\[rq] for valid color names.
 .TP
 .B set stateflags
 Use the top-right corner of the screen for showing some state flags:
@@ -374,11 +374,11 @@ .SH OPTIONS
 .TP
 .B set statuscolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the status bar.
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set stripecolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the vertical guiding stripe.
-See \fBset titlecolor\fR for more details.
+See \[lq]\fBset titlecolor\fR\[rq] for more details.
 .TP
 .B set tabsize \fInumber\fR
 Use a tab size of \fInumber\fR columns.  The value of \fInumber\fR must be
@@ -425,7 +425,7 @@ .SH OPTIONS
 .B set unix
 Save a file by default in Unix format.  This overrides \fBnano\fR's
 default behavior of saving a file in the format that it had.
-(This option has no effect when you also use \fBset noconvert\fR.)
+(This option has no effect when you also use \[lq]\fBset noconvert\fR\[rq].)
 .TP
 .BI "set whitespace \[dq]" characters \[dq]
 Set the two characters used to indicate the presence of tabs and
@@ -515,7 +515,7 @@ .SH SYNTAX HIGHLIGHTING
 result of querying the \fBmagic\fR database about the current
 file, to determine whether this syntax should be used for it.
 (This querying is done only when \fIlibmagic\fR is actually installed
-on the system and \fB\-\-magic\fR or \fBset magic\fR was given.)
+on the system and \fB\-\-magic\fR or \[lq]\fBset magic\fR\[rq] was given.)
 .TP
 .BI formatter " program " \fR[ "argument " \fR.\|.\|.]
 Run the given \fIprogram\fR on the full contents of the current buffer.
@@ -754,7 +754,7 @@ .SH REBINDING KEYS
 .TP
 .B speller
 Invokes a spell-checking program, either the default \fBhunspell\fR(1) or GNU
-\fBspell\fR(1), or the one defined by \fB\-\-speller\fR or \fBset speller\fR.
+\fBspell\fR(1), or the one defined by \fB\-\-speller\fR or \[lq]\fBset speller\fR\[rq].
 .TP
 .B formatter
 Invokes a full-buffer-processing program (if the active syntax defines one).
-- 
2.30.2
signature.asc (application/pgp-signature, 833 B)