Package: nano
Version: 8.3-1
Severity: minor
Tags: patch

   * What led up to the situation?

     Checking for defects with a new version

test-[g|n]roff -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z < "man 
page"

  [Use "groff -e ' $' -e '\\~$' <file>" to find obvious trailing spaces.]

  ["test-groff" is a script in the repository for "groff"; is not shipped]
(local copy and "troff" slightly changed by me).

  [The fate of "test-nroff" was decided in groff bug #55941.]

   * What was the outcome of this action?

troff:<stdin>:372: warning: trailing space in the line
troff:<stdin>:382: warning: trailing space in the line
troff:<stdin>:383: warning: trailing space in the line
troff:<stdin>:384: warning: trailing space in the line
troff:<stdin>:385: warning: trailing space in the line
troff:<stdin>:523: warning: trailing space in the line
troff:<stdin>:533: warning: trailing space in the line
troff:<stdin>:534: warning: trailing space in the line
troff:<stdin>:535: warning: trailing space in the line
troff:<stdin>:536: warning: trailing space in the line

   * What outcome did you expect instead?

     No output (no warnings).

-.-

  General remarks and further material, if a diff-file exist, are in the
attachments.


-- System Information:
Debian Release: trixie/sid
  APT prefers testing
  APT policy: (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 6.12.12-amd64 (SMP w/2 CPU threads; PREEMPT)
Locale: LANG=is_IS.iso88591, LC_CTYPE=is_IS.iso88591 (charmap=ISO-8859-1), 
LANGUAGE not set
Shell: /bin/sh linked to /usr/bin/dash
Init: sysvinit (via /sbin/init)

Versions of packages nano depends on:
ii  libc6         2.40-6
ii  libncursesw6  6.5+20250125-2
ii  libtinfo6     6.5+20250125-2

nano recommends no packages.

Versions of packages nano suggests:
ii  hunspell  1.7.2+really1.7.2-10+b4

-- no debconf information
Input file is nanorc.5

Output from "mandoc -T lint  nanorc.5": (shortened list)


      1 input text line longer than 80 bytes: (Often, \fBF13\fR to...
      1 input text line longer than 80 bytes: The menu of the inte...
      1 input text line longer than 80 bytes: Toggles the constant...
      1 input text line longer than 80 bytes: Toggles the presence...
      1 input text line longer than 80 bytes: Use cut-from-cursor-...
      1 input text line longer than 80 bytes: Use this color combi...
      1 input text line longer than 80 bytes: When writing a file,...
      1 input text line longer than 80 bytes: at startup time (and...
      1 input text line longer than 80 bytes: but not whether it m...
     13 unterminated quoted argument


-.-.

Output from "test-groff -mandoc -t -ww -z nanorc.5": (shortened list)

     10 trailing space in the line

Remove trailing space with: sed -e 's/  *$//'

-.-.

Change two HYPHEN-MINUSES (code 0x2D) to an em-dash (\(em),
if one is intended.
  " \(em " creates a too big gap in the text (in "troff").

An en-dash is usually surrounded by a space,
while an em-dash is used without spaces.
"man" (1 byte characters in input) transforms an en-dash (\(en) to one
HYPHEN-MINUS,
and an em-dash to two HYPHEN-MINUSES without considering the space
around it.
If "--" are two single "-"
(begin of an option or end of options)
then use "\-\-".

nanorc.5:59:syntax highlighting and to rebind keys -- see the two separate 
sections
nanorc.5:98:numbered one every time a file is saved -- when backups are enabled
nanorc.5:365:Convert each typed tab to spaces -- to the number of spaces
nanorc.5:387:-- where \fBnormal\fR means the default foreground or background 
color.
nanorc.5:538:-- where \fBnormal\fR means the default foreground or background 
color.
nanorc.5:576:command to an already defined syntax -- useful when you want to
nanorc.5:669:Starts a forward search for text in the current buffer -- or for 
filenames
nanorc.5:673:Starts a backward search for text in the current buffer -- or for 
filenames
nanorc.5:886:Starts the recording of keystrokes -- the keystrokes are stored
nanorc.5:1004:whitespace as the preceding line -- or as the next line if the 
preceding line

-.-.

Use "\e" to print the escape character instead of "\\" (which gets
interpreted in copy mode).

286:The default value is "\fB^([\ \\t]*([!#%:;>|}]|//))+\fP".
287:(Note that \fB\\t\fR stands for an actual Tab character.)
449:\fB\\<\fR matches the start of a word, and \fB\\>\fR the end,
450:and \fB\\s\fR matches a blank.
615:(@, ], \\, ^, _), or the word "Space".

-.-.

Change a HYPHEN-MINUS (code 0x2D) to a minus(-dash) (\-),
if it
is in front of a name for an option,
is a symbol for standard input,
is a single character used to indicate an option,
or is in the NAME section (man-pages(7)).
N.B. - (0x2D), processed as a UTF-8 file, is changed to a hyphen
(0x2010, groff \[u2010] or \[hy]) in the output.

1089:.B bind Sh-M-C """{execute}| xsel -ib {enter}{undo}""" main

-.-.

Wrong distance between sentences in the input file.

  Separate the sentences and subordinate clauses; each begins on a new
line.  See man-pages(7) ("Conventions for source file layout") and
"info groff" ("Input Conventions").

  The best procedure is to always start a new sentence on a new line,
at least, if you are typing on a computer.

Remember coding: Only one command ("sentence") on each (logical) line.

E-mail: Easier to quote exactly the relevant lines.

Generally: Easier to edit the sentence.

Patches: Less unaffected text.

Search for two adjacent words is easier, when they belong to the same line,
and the same phrase.

  The amount of space between sentences in the output can then be
controlled with the ".ss" request.

Mark a final abbreviation point as such by suffixing it with "\&".

Some sentences (etc.) do not begin on a new line.


850:Moves the cursor to the bracket (or brace or parenthesis, etc.) that matches

-.-.

Split lines longer than 80 characters into two or more lines.
Appropriate break points are the end of a sentence and a subordinate
clause; after punctuation marks.

Line 140, length 81

Use cut-from-cursor-to-end-of-line by default, instead of cutting the whole 
line.

Line 146, length 81

Use this color combination for the status bar when an error message is 
displayed.

Line 519, length 86

.BI "color \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " """ regex """ " 
\fR...

Line 551, length 87

.BI "icolor \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " """ regex """ 
" \fR...

Line 554, length 101

.BI "color \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " start=""" 
fromrx """ end=""" torx """

Line 563, length 102

.BI "icolor \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " start=""" 
fromrx """ end=""" torx """

Line 603, length 82

at startup time (and reports an error if it does not exist there), whereas for 
the

Line 605, length 82

but not whether it makes any sense in the current menu.  The user has to take 
care

Line 632, length 81

(Often, \fBF13\fR to \fBF24\fR can be typed as \fBF1\fR to \fBF12\fR with 
Shift.)

Line 952, length 81

When writing a file, 'prepends' (writes at the beginning) instead of 
overwriting.

Line 977, length 86

Toggles the presence of the two-line list of key bindings at the bottom of the 
screen.

Line 985, length 82

Toggles the constant display of the current line, column, and character 
positions.

Line 1068, length 83

The menu of the integrated spell checker where the user can edit a misspelled 
word.


-.-.

Put a parenthetical sentence, phrase on a separate line,
if not part of a code.
See man-pages(7), item "semantic newline".

Not considered in a patch, too many lines.


nanorc.5:28:from \fI/etc/nanorc\fP (the exact path might be different on your 
system),
nanorc.5:111:beginning of a paragraph (unless auto-indenting is on).
nanorc.5:116:punctuation (see \fBset punct\fP), optionally followed by the 
specified
nanorc.5:164:text.  (The color of the stripe can be changed with \fBset 
stripecolor\fR.)
nanorc.5:208:code of the character under the cursor (in Unicode format: U+xxxx),
nanorc.5:263:Preserve the XOFF and XON sequences (\fB^S\fR and \fB^Q\fR) so that
nanorc.5:264:they are caught by the terminal (stopping and resuming the output).
nanorc.5:327:to that beginning (either forwards or backwards).  If the cursor is
nanorc.5:347:hard-wrapping (breaking long lines), \fBR\fR when recording a 
macro,
nanorc.5:381:other valid (but unprefixable) color names are:
nanorc.5:417:Specify which other characters (besides the normal alphanumeric 
ones)
nanorc.5:426:Hide all elements of the interface (title bar, status bar, and 
help lines)
nanorc.5:435:is done via regular expressions (see the \fBcolor\fR command 
below).
nanorc.5:473:activated (for the relevant buffer) if the absolute filename
nanorc.5:475:Or the syntax can be explicitly activated (for all buffers)
nanorc.5:486:this \fIregex\fR (or regexes) against the first line of the 
current file,
nanorc.5:491:either, then compare this \fIregex\fR (or regexes) against the
nanorc.5:532:other valid (but unprefixable) color names are:
nanorc.5:578:files (which normally are not writable).
nanorc.5:590:\fImenu\fR (or in all menus where the key exists when \fBall\fR is 
used).
nanorc.5:603:at startup time (and reports an error if it does not exist there), 
whereas for the
nanorc.5:606:that a function name between braces (or any sequence of them) is 
appropriate.
nanorc.5:656:Exits from the program (or from the help viewer or file browser).
nanorc.5:665:Inserts a file into the current buffer (at the current cursor 
position),
nanorc.5:686:Cuts and stores the current line (or the marked region).
nanorc.5:689:Copies the current line (or the marked region) without deleting it.
nanorc.5:696:Throws away the current line (or the marked region).
nanorc.5:722:and characters in the current buffer (or in the marked region).
nanorc.5:726:into the current buffer (or into a new buffer when \fBM\-F\fR is 
toggled).
nanorc.5:733:Invokes a full-buffer-processing program (if the active syntax 
defines one).
nanorc.5:739:Invokes a syntax-checking program (if the active syntax defines 
one).
nanorc.5:747:Justifies the current paragraph (or the marked region).
nanorc.5:754:Justifies the entire current buffer (or the marked region).
nanorc.5:757:Indents (shifts to the right) the current line or the marked lines.
nanorc.5:760:Unindents (shifts to the left) the current line or the marked 
lines.
nanorc.5:767:Completes (when possible) the fragment before the cursor
nanorc.5:771:Goes left one position (in the editor or browser).
nanorc.5:774:Goes right one position (in the editor or browser).
nanorc.5:777:Goes one line up (in the editor or browser).
nanorc.5:780:Goes one line down (in the editor or browser).
nanorc.5:783:Scrolls the viewport up one row (meaning that the text slides down)
nanorc.5:791:Scrolls the viewport down one row (meaning that the text slides up)
nanorc.5:846:Goes to a specific line (and column if specified).  Negative 
numbers count
nanorc.5:847:from the end of the file (and end of the line).
nanorc.5:850:Moves the cursor to the bracket (or brace or parenthesis, etc.) 
that matches
nanorc.5:893:Undoes the last performed text action (add text, delete text, etc).
nanorc.5:896:Redoes the last undone action (i.e., it undoes an undo).
nanorc.5:952:When writing a file, 'prepends' (writes at the beginning) instead 
of overwriting.
nanorc.5:963:Starts the file browser (in the Read File and Write Out menus),
nanorc.5:1032:The search menu (AKA whereis).
nanorc.5:1044:The 'goto line (and column)' menu.
nanorc.5:1064:or for filtering the buffer (or the marked region) through

-.-.

No space is needed before a quote (") at the end of a macro line

372:.BR red ", " green ", " blue ", " magenta ", " yellow ", " cyan ", "
382:.BR pink ", " purple ", " mauve ", " lagoon ", " mint ", "
383:.BR lime ", " peach ", " orange ", " latte ", "
384:.BR rosy ", " beet ", " plum ", " sea ", " sky ", " slate ", "
385:.BR teal ", " sage ", " brown ", " ocher ", " sand ", " tawny ", "
523:.BR red ", " green ", " blue ", " magenta ", " yellow ", " cyan ", "
533:.BR pink ", " purple ", " mauve ", " lagoon ", " mint ", "
534:.BR lime ", " peach ", " orange ", " latte ", "
535:.BR rosy ", " beet ", " plum ", " sea ", " sky ", " slate ", "
536:.BR teal ", " sage ", " brown ", " ocher ", " sand ", " tawny ", "

-.-.

Remove quotes when there is a printable
but no space character between them
and the quotes are not for emphasis (markup),
for example as an argument to a macro.

96:.B set backupdir "\fIdirectory\fP"
252:.B set operatingdir "\fIdirectory\fP"

-.-.

Output from "test-groff  -mandoc -t -K utf8 -rF0 -rHY=0 -rCHECKSTYLE=10 -ww -z 
":

troff:<stdin>:372: warning: trailing space in the line
troff:<stdin>:382: warning: trailing space in the line
troff:<stdin>:383: warning: trailing space in the line
troff:<stdin>:384: warning: trailing space in the line
troff:<stdin>:385: warning: trailing space in the line
troff:<stdin>:523: warning: trailing space in the line
troff:<stdin>:533: warning: trailing space in the line
troff:<stdin>:534: warning: trailing space in the line
troff:<stdin>:535: warning: trailing space in the line
troff:<stdin>:536: warning: trailing space in the line

-.-

Protect a single quote (') from coming a control character
if it could end up at the start of a line.
--- nanorc.5    2025-02-14 08:41:50.536549931 +0000
+++ nanorc.5.new        2025-02-14 09:30:18.113999928 +0000
@@ -56,7 +56,7 @@ lines at the end of your \fInanorc\fR fi
 The configuration file accepts a series of \fBset\fP and \fBunset\fP
 commands, which can be used to configure nano on startup without using
 command-line options.  Additionally, there are some commands to define
-syntax highlighting and to rebind keys -- see the two separate sections
+syntax highlighting and to rebind keys \(en see the two separate sections
 on those.  \fBnano\fP reads one command per line.
 All commands and keywords should be written in lowercase.
 .sp
@@ -93,9 +93,9 @@ line is the beginning of a paragraph).
 When saving a file, create a backup file by adding a tilde (\fB~\fP) to
 the file's name.
 .TP
-.B set backupdir "\fIdirectory\fP"
+.B set backupdir \fIdirectory\fP
 Make and keep not just one backup file, but make and keep a uniquely
-numbered one every time a file is saved -- when backups are enabled
+numbered one every time a file is saved \(en when backups are enabled
 with \fBset backup\fR or \fB\-\-backup\fR or \fB\-B\fR.
 The uniquely numbered files are stored in the specified \fIdirectory\fR.
 .TP
@@ -137,13 +137,15 @@ Constantly display the cursor position i
 This overrides the option \fBquickblank\fR.
 .TP
 .B set cutfromcursor
-Use cut-from-cursor-to-end-of-line by default, instead of cutting the whole 
line.
+Use cut-from-cursor-to-end-of-line by default,
+instead of cutting the whole line.
 .TP
 .B set emptyline
 Do not use the line below the title bar, leaving it entirely blank.
 .TP
 .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.
+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.
 .TP
@@ -249,7 +251,7 @@ When needed, use \fBunset breaklonglines
 Use this color combination for line numbers.
 See \fBset titlecolor\fR for more details.
 .TP
-.B set operatingdir "\fIdirectory\fP"
+.B set operatingdir \fIdirectory\fP
 \fBnano\fP only reads and writes files inside \fIdirectory\fP and its
 subdirectories.  Also, the current directory is changed to here, so
 files are inserted from this directory.  By default, the operating
@@ -283,8 +285,8 @@ When option \fBminibar\fR or \fBzero\fR
 .TP
 .BI "set quotestr """ regex """
 Set the regular expression for matching the quoting part of a line.
-The default value is "\fB^([\ \\t]*([!#%:;>|}]|//))+\fP".
-(Note that \fB\\t\fR stands for an actual Tab character.)
+The default value is "\fB^([\ \et]*([!#%:;>|}]|//))+\fP".
+(Note that \fB\et\fR stands for an actual Tab character.)
 This makes it possible to rejustify blocks of quoted text when composing
 email, and to rewrap blocks of line comments when writing source code.
 .TP
@@ -362,14 +364,14 @@ Use a tab size of \fInumber\fR columns.
 greater than 0.  The default value is \fB8\fR.
 .TP
 .B set tabstospaces
-Convert each typed tab to spaces -- to the number of spaces
+Convert each typed tab to spaces \(en to the number of spaces
 that a tab at that position would take up.
 (Note: pasted tabs are not converted.)
 .TP
 .B set titlecolor \fR[\fBbold,\fR][\fBitalic,\fR]\fIfgcolor\fB,\fIbgcolor\fR
 Use this color combination for the title bar.
 Valid names for the foreground and background colors are:
-.BR red ", " green ", " blue ", " magenta ", " yellow ", " cyan ", "
+.BR red ", " green ", " blue ", " magenta ", " yellow ", " cyan ,
 .BR white ", and " black .
 Each of these eight names may be prefixed with the word \fBlight\fR
 to get a brighter version of that color.
@@ -379,12 +381,12 @@ On a Linux console, \fBlight\fR does not
 any effect for a background color.
 On terminal emulators that can do at least 256 colors,
 other valid (but unprefixable) color names are:
-.BR pink ", " purple ", " mauve ", " lagoon ", " mint ", "
-.BR lime ", " peach ", " orange ", " latte ", "
-.BR rosy ", " beet ", " plum ", " sea ", " sky ", " slate ", "
-.BR teal ", " sage ", " brown ", " ocher ", " sand ", " tawny ", "
+.BR pink ", " purple ", " mauve ", " lagoon ", " mint ,
+.BR lime ", " peach ", " orange ", " latte ,
+.BR rosy ", " beet ", " plum ", " sea ", " sky ", " slate ,
+.BR teal ", " sage ", " brown ", " ocher ", " sand ", " tawny ,
 .BR brick ", " crimson ", and " normal
--- where \fBnormal\fR means the default foreground or background color.
+\(em where \fBnormal\fR means the default foreground or background color.
 On such emulators, the color may also be specified as a three-digit hexadecimal
 number prefixed with \fB#\fR, with the digits representing the amounts of red,
 green, and blue, respectively.  This tells \fBnano\fR to select from the
@@ -446,8 +448,8 @@ The period \fB.\fR matches any single ch
 \fB*\fR means the preceding item may be matched zero or more times,
 \fB+\fR means the preceding item must be matched one or more times,
 \fB^\fR matches the beginning of a line, and \fB$\fR the end,
-\fB\\<\fR matches the start of a word, and \fB\\>\fR the end,
-and \fB\\s\fR matches a blank.
+\fB\e<\fR matches the start of a word, and \fB\e>\fR the end,
+and \fB\es\fR matches a blank.
 It also means that lookahead and lookbehind are not possible.
 A complete explanation can be found in the manual page of GNU grep:
 \fBman grep\fR.
@@ -516,11 +518,12 @@ Make the <Tab> key produce the given \fI
 Python that want to see only spaces for indentation.
 This overrides the setting of the \fBtabstospaces\fR option.
 .TP
-.BI "color \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " """ regex """ 
" \fR...
+.BI "color \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " """ regex \
+""" " \fR...
 Paint all pieces of text that match the extended regular expression
 \fIregex\fP with the given foreground and background colors, at least
 one of which must be specified.  Valid color names are:
-.BR red ", " green ", " blue ", " magenta ", " yellow ", " cyan ", "
+.BR red ", " green ", " blue ", " magenta ", " yellow ", " cyan ,
 .BR white ", and " black .
 Each of these eight names may be prefixed with the word \fBlight\fR
 to get a brighter version of that color.
@@ -530,12 +533,12 @@ On a Linux console, \fBlight\fR does not
 any effect for a background color.
 On terminal emulators that can do at least 256 colors,
 other valid (but unprefixable) color names are:
-.BR pink ", " purple ", " mauve ", " lagoon ", " mint ", "
-.BR lime ", " peach ", " orange ", " latte ", "
-.BR rosy ", " beet ", " plum ", " sea ", " sky ", " slate ", "
-.BR teal ", " sage ", " brown ", " ocher ", " sand ", " tawny ", "
+.BR pink ", " purple ", " mauve ", " lagoon ", " mint ,
+.BR lime ", " peach ", " orange ", " latte ,
+.BR rosy ", " beet ", " plum ", " sea ", " sky ", " slate ,
+.BR teal ", " sage ", " brown ", " ocher ", " sand ", " tawny ,
 .BR brick ", " crimson ", and " normal
--- where \fBnormal\fR means the default foreground or background color.
+\(em where \fBnormal\fR means the default foreground or background color.
 On such emulators, the color may also be specified as a three-digit hexadecimal
 number prefixed with \fB#\fR, with the digits representing the amounts of red,
 green, and blue, respectively.  This tells \fBnano\fR to select from the
@@ -548,10 +551,12 @@ if your terminal can do those.
 All coloring commands are applied in the order in which they are specified,
 which means that later commands can recolor stuff that was colored earlier.
 .TP
-.BI "icolor \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " """ regex """ 
" \fR...
+.BI "icolor \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " """ \
+regex """ " \fR...
 Same as above, except that the matching is case insensitive.
 .TP
-.BI "color \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " start=""" 
fromrx """ end=""" torx """
+.BI "color \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " start=""" \
+fromrx """ end=""" torx """
 Paint all pieces of text whose start matches extended regular expression
 \fIfromrx\fP and whose end matches extended regular expression \fItorx\fP
 with the given foreground and background colors,
@@ -560,7 +565,8 @@ initial instance of \fIfromrx\fP, all te
 \fItorx\fP is colored.  This allows syntax highlighting to span
 multiple lines.
 .TP
-.BI "icolor \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor " start=""" 
fromrx """ end=""" torx """
+.BI "icolor \fR[\fBbold,\fR][\fBitalic,\fR]" fgcolor , bgcolor \
+" start=""" fromrx """ end=""" torx """
 Same as above, except that the matching is case insensitive.
 .TP
 .BI "include """ syntaxfile """
@@ -573,7 +579,7 @@ Extend the syntax previously defined as
 \fIcommand\fR.  This allows adding a new \fBcolor\fP, \fBicolor\fP,
 \fBheader\fR, \fBmagic\fR, \fBformatter\fR, \fBlinter\fR, \fBcomment\fR,
 or \fBtabgives\fR
-command to an already defined syntax -- useful when you want to
+command to an already defined syntax \(en useful when you want to
 slightly improve a syntax defined in one of the system-installed
 files (which normally are not writable).
 
@@ -600,9 +606,12 @@ menus where the key exists when \fBall\f
 Note that \fBbind \fIkey\fR \fB"{\fIfunction\fB}"\fR \fImenu\fR is equivalent
 to \fBbind \fIkey\fR \fIfunction\fR \fImenu\fR, except that for the latter form
 \fBnano\fR checks the availability of the \fIfunction\fR in the given 
\fImenu\fR
-at startup time (and reports an error if it does not exist there), whereas for 
the
+at startup time
+(and reports an error if it does not exist there),
+whereas for the
 first form \fBnano\fR checks at execution time that the \fIfunction\fR exists
-but not whether it makes any sense in the current menu.  The user has to take 
care
+but not whether it makes any sense in the current menu.
+The user has to take care
 that a function name between braces (or any sequence of them) is appropriate.
 Strange behavior or even a crash can result when the braced name is unfitting.
 
@@ -612,7 +621,7 @@ The format of \fIkey\fP should be one of
 .TP 7
 .BI ^ X
 where \fIX\fR is a Latin letter, or one of several ASCII characters
-(@, ], \\, ^, _), or the word "Space".
+(@, ], \e, ^, _), or the word "Space".
 Example: ^C.
 .TP
 .BI M\- X
@@ -629,7 +638,8 @@ no longer be the case, for all letters.
 .BI F N
 where \fIN\fR is a numeric value from 1 to 24.
 Example: F10.
-(Often, \fBF13\fR to \fBF24\fR can be typed as \fBF1\fR to \fBF12\fR with 
Shift.)
+(Often,
+\fBF13\fR to \fBF24\fR can be typed as \fBF1\fR to \fBF12\fR with Shift.)
 .TP
 .BR Ins " or " Del .
 .RE
@@ -666,11 +676,11 @@ Inserts a file into the current buffer (
 or into a new buffer when option \fBmultibuffer\fR is set.
 .TP
 .B whereis
-Starts a forward search for text in the current buffer -- or for filenames
+Starts a forward search for text in the current buffer \(en or for filenames
 matching a string in the current list in the file browser.
 .TP
 .B wherewas
-Starts a backward search for text in the current buffer -- or for filenames
+Starts a backward search for text in the current buffer \(en or for filenames
 matching a string in the current list in the file browser.
 .TP
 .B findprevious
@@ -847,7 +857,7 @@ Goes to a specific line (and column if s
 from the end of the file (and end of the line).
 .TP
 .B findbracket
-Moves the cursor to the bracket (or brace or parenthesis, etc.) that matches
+Moves the cursor to the bracket (or brace or parenthesis, etc.\&) that matches
 (pairs) with the one under the cursor.  See \fBset matchbrackets\fR.
 .TP
 .B anchor
@@ -883,7 +893,7 @@ Deletes the character under the cursor.
 Deletes the character before the cursor.
 .TP
 .B recordmacro
-Starts the recording of keystrokes -- the keystrokes are stored
+Starts the recording of keystrokes \(en the keystrokes are stored
 as a macro.  When already recording, the recording is stopped.
 .TP
 .B runmacro
@@ -949,7 +959,10 @@ When writing a file, switches to writing
 When writing a file, appends to the end instead of overwriting.
 .TP
 .B prepend
-When writing a file, 'prepends' (writes at the beginning) instead of 
overwriting.
+When writing a file,
+\&'prepends'
+(writes at the beginning)
+instead of overwriting.
 .TP
 .B backup
 When writing a file, creates a backup of the current file.
@@ -974,7 +987,8 @@ Goes to the first file in the list when
 Goes to the last file in the list when using the file browser.
 .TP
 .B nohelp
-Toggles the presence of the two-line list of key bindings at the bottom of the 
screen.
+Toggles the presence of the two-line list of key bindings
+at the bottom of the screen.
 (This toggle is special: it is available in all menus except the help viewer
 and the linter.  All further toggles are available in the main menu only.)
 .TP
@@ -982,7 +996,9 @@ and the linter.  All further toggles are
 Toggles the presence of title bar and status bar.
 .TP
 .B constantshow
-Toggles the constant display of the current line, column, and character 
positions.
+Toggles the constant display of the current line,
+column,
+and character positions.
 .TP
 .B softwrap
 Toggles the displaying of overlong lines on multiple screen lines.
@@ -1001,7 +1017,7 @@ Toggles the smartness of the Home key.
 .TP
 .B autoindent
 Toggles whether a newly created line will contain the same amount of leading
-whitespace as the preceding line -- or as the next line if the preceding line
+whitespace as the preceding line \(en or as the next line if the preceding line
 is the beginning of a paragraph.
 .TP
 .B cutfromcursor
@@ -1032,32 +1048,32 @@ The help-viewer menu.
 The search menu (AKA whereis).
 .TP
 .B replace
-The 'search to replace' menu.
+The \&'search to replace' menu.
 .TP
 .B replacewith
-The 'replace with' menu, which comes up after 'search to replace'.
+The \&'replace with' menu, which comes up after \&'search to replace'.
 .TP
 .B yesno
-The 'yesno' menu, where the Yes/No/All/Cancel question is asked.
+The \&'yesno' menu, where the Yes/No/All/Cancel question is asked.
 .TP
 .B gotoline
-The 'goto line (and column)' menu.
+The \&'goto line (and column)' menu.
 .TP
 .B writeout
-The 'write file' menu.
+The \&'write file' menu.
 .TP
 .B insert
-The 'insert file' menu.
+The \&'insert file' menu.
 .TP
 .B browser
-The 'file browser' menu, for selecting a file to be opened or
+The \&'file browser' menu, for selecting a file to be opened or
 inserted or written to.
 .TP
 .B whereisfile
-The 'search for a file' menu in the file browser.
+The \&'search for a file' menu in the file browser.
 .TP
 .B gotodir
-The 'go to directory' menu in the file browser.
+The \&'go to directory' menu in the file browser.
 .TP
 .B execute
 The menu for inserting the output from an external command,
@@ -1065,7 +1081,8 @@ or for filtering the buffer (or the mark
 an external command, or for executing one of several tools.
 .TP
 .B spell
-The menu of the integrated spell checker where the user can edit a misspelled 
word.
+The menu of the integrated spell checker
+where the user can edit a misspelled word.
 .TP
 .B linter
 The linter menu, which allows jumping through the linting messages.
@@ -1086,7 +1103,7 @@ To make \fBCtrl+Z\fR suspend nano:
 To make \fBShift+Alt+C\fR copy the marked region to the system's clipboard:
 .sp
 .RS
-.B bind Sh-M-C """{execute}| xsel -ib {enter}{undo}""" main
+.B bind Sh-M-C """{execute}| xsel \-ib {enter}{undo}""" main
 .RE
 .sp
 
  Any program (person), that produces man pages, should check the output
for defects by using (both groff and nroff)

[gn]roff -mandoc -t -ww -b -z -K utf8 <man page>

  The same goes for man pages that are used as an input.

  For a style guide use

  mandoc -T lint

-.-

  Any "autogenerator" should check its products with the above mentioned
'groff', 'mandoc', and additionally with 'nroff ...'.

  It should also check its input files for too long (> 80) lines.

  This is just a simple quality control measure.

  The "autogenerator" may have to be corrected to get a better man page,
the source file may, and any additional file may.

  Common defects:

  Not removing trailing spaces (in in- and output).
  The reason for these trailing spaces should be found and eliminated.

  Not beginning each input sentence on a new line.
Line length should thus be reduced.

  The script "reportbug" uses 'quoted-printable' encoding when a line is
longer than 1024 characters in an 'ascii' file.

  See man-pages(7), item "semantic newline".

-.-

The difference between the formatted output of the original and patched file
can be seen with:

  nroff -mandoc <file1> > <out1>
  nroff -mandoc <file2> > <out2>
  diff -d -u <out1> <out2>

and for groff, using

\"printf '%s\n%s\n' '.kern 0' '.ss 12 0' | groff -mandoc -Z - \"

instead of 'nroff -mandoc'

  Add the option '-t', if the file contains a table.

  Read the output from 'diff -d -u ...' with 'less -R' or similar.

-.-.

  If 'man' (man-db) is used to check the manual for warnings,
the following must be set:

  The option \"-warnings=w\"

  The environmental variable:

export MAN_KEEP_STDERR=yes (or any non-empty value)

  or

  (produce only warnings):

export MANROFFOPT=\"-ww -b -z\"

export MAN_KEEP_STDERR=yes (or any non-empty value)

-.-

Reply via email to