[PATCH 09/31] docs: use groff-style special character syntax
"G. Branden Robinson" <[email protected]> Thu, 23 Apr 2026 17:58:27 -0500
| Newsgroups | gmane.editors.nano.devel |
|---|---|
| Message-ID | <20260423225827.r2sa25u2jf3dluwd@illithid> |
nano already uses `\[bu]`, `\[Fc]`, and `\[md]`. The last two are not portable to AT&T even if spelled with AT&T syntax. See groff_char(7). --- doc/nano.1 | 12 ++++++------ doc/nanorc.5 | 28 ++++++++++++++-------------- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/doc/nano.1 b/doc/nano.1 index a11cd3d7..aa2fb5aa 100644 --- a/doc/nano.1 +++ b/doc/nano.1 @@ -123,7 +123,7 @@ .SH EDITING .P The two lines at the bottom of the screen show some important commands; the built-in help (\fB^G\fR) lists all the available ones. -The default key bindings can be changed via a \fInanorc\fR file \(em see +The default key bindings can be changed via a \fInanorc\fR file \[em] see .BR nanorc (5). . .SH OPTIONS @@ -140,7 +140,7 @@ .SH OPTIONS .TP .BI \-C " directory\fR, " \-\-backupdir= directory Make and keep not just one backup file, but make and keep a uniquely numbered -one every time a file is saved \(em when backups are enabled (\fB\-B\fR). +one every time a file is saved \[em] when backups are enabled (\fB\-B\fR). The uniquely numbered files are stored in the specified \fIdirectory\fR. .TP .BR \-D ", " \-\-boldtext @@ -151,7 +151,7 @@ .SH OPTIONS \fB\%selectedcolor\fR in your nanorc file. See \fBnanorc\fR(5). .TP .BR \-E ", " \-\-tabstospaces -Convert each typed tab to spaces \(em to the number of spaces +Convert each typed tab to spaces \[em] to the number of spaces that a tab at that position would take up. (Note: pasted tabs are not converted.) .TP @@ -263,7 +263,7 @@ .SH OPTIONS that is: when it becomes wider than the value given with \fB\-r\fR (\fB\-\-fill\fR). The default value for \fB-r\fR is the terminal's width minus eight. -(This option is the opposite of \fB\-w\fR (\fB\-\-nowrap\fR) \(em +(This option is the opposite of \fB\-w\fR (\fB\-\-nowrap\fR) \[em] the last one given takes effect.) .TP .BR \-c ", " \-\-constantshow @@ -361,7 +361,7 @@ .SH OPTIONS .BR \-w ", " \-\-nowrap Do not automatically hard-wrap the current line when it becomes overlong. This is the default. (This option is the opposite of \fB\-b\fR -(\fB\-\-breaklonglines\fR) \(em the last one given takes effect.) +(\fB\-\-breaklonglines\fR) \[em] the last one given takes effect.) .TP .BR \-x ", " \-\-nohelp Don't show the two help lines at the bottom of the screen. @@ -425,7 +425,7 @@ .SH OPTIONS sideways by just the amount needed to keep the cursor in view. This latter whole-window smooth sideways scrolling is the new default behavior. The single-line jerky sideways scrolling enabled by this option was the old -behavior \(em the only behavior that \fBnano\fR knew. +behavior \[em] the only behavior that \fBnano\fR knew. .TP .BR \-/ ", " \-\-modernbindings Use key bindings similar to the ones that most modern programs use: diff --git a/doc/nanorc.5 b/doc/nanorc.5 index 93b04f17..bf73fd03 100644 --- a/doc/nanorc.5 +++ b/doc/nanorc.5 @@ -71,7 +71,7 @@ .SH OPTIONS The configuration file accepts a series of \fBset\fR and \fBunset\fR 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 \(em see the two separate sections +syntax highlighting and to rebind keys \[em] see the two separate sections on those. \fBnano\fR reads one command per line. All commands and keywords should be written in lowercase. .P @@ -110,7 +110,7 @@ .SH OPTIONS .TP .B set backupdir \fIdirectory\fR Make and keep not just one backup file, but make and keep a uniquely -numbered one every time a file is saved \(em when backups are enabled +numbered one every time a file is saved \[em] 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 @@ -129,10 +129,10 @@ .SH OPTIONS 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 -closing brackets, can end sentences. The default value is "\fB\(dq')>]}\fR". +closing brackets, can end sentences. The default value is "\fB\[dq]')>]}\fR". .TP .B set breaklonglines -Automatically hard-wrap the current line when it becomes overlong \(em +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 (which defaults to the width of the terminal minus eight). .TP @@ -353,7 +353,7 @@ .SH OPTIONS sideways by just the amount needed to keep the cursor in view. This latter whole-window smooth sideways scrolling is the new default behavior. The single-line jerky sideways scrolling enabled by this option was the old -behavior \(em the only behavior that \fBnano\fR knew. +behavior \[em] the only behavior that \fBnano\fR knew. .TP .B set speller """\fIprogram\fR [\fIargument \fR.\|.\|.]\fB""" Use the given \fIprogram\fR to do spell checking and correcting, instead of @@ -385,7 +385,7 @@ .SH OPTIONS greater than 0. The default value is \fB8\fR. .TP .B set tabstospaces -Convert each typed tab to spaces \(em to the number of spaces +Convert each typed tab to spaces \[em] to the number of spaces that a tab at that position would take up. (Note: pasted tabs are not converted.) .TP @@ -406,7 +406,7 @@ .SH OPTIONS .BR \%orange ", " \%latte ", " \%rosy ", " beet ", " plum ", " sea ", " sky , .BR slate ", " teal ", " sage ", " brown ", " \%ocher ", " sand ", " \%tawny , .BR brick ", " \%crimson ", and " \%normal -\(em where \fB\%normal\fR means the default foreground or background color. +\[em] where \fB\%normal\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 @@ -557,7 +557,7 @@ .SH SYNTAX HIGHLIGHTING .BR \%orange ", " \%latte ", " \%rosy ", " beet ", " plum ", " sea ", " sky , .BR slate ", " teal ", " sage ", " brown ", " \%ocher ", " sand ", " \%tawny , .BR brick ", " \%crimson ", and " \%normal -\(em where \fB\%normal\fR means the default foreground or background color. +\[em] where \fB\%normal\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 @@ -596,7 +596,7 @@ .SH SYNTAX HIGHLIGHTING \fI\%command\fR. This allows adding a new \fB\%color\fR, \fB\%icolor\fR, \fB\%header\fR, \fB\%magic\fR, \fB\%formatter\fR, \fB\%linter\fR, \fB\%comment\fR, or \fB\%tabgives\fR -command to an already defined syntax \(em useful when you want to +command to an already defined syntax \[em] useful when you want to slightly improve a syntax defined in one of the system-installed files (which normally are not writable). . @@ -690,11 +690,11 @@ .SH REBINDING KEYS or into a new buffer when option \fBmultibuffer\fR is set. .TP .B whereis -Starts a forward search for text in the current buffer \(em or for filenames +Starts a forward search for text in the current buffer \[em] 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 \(em or for filenames +Starts a backward search for text in the current buffer \[em] or for filenames matching a string in the current list in the file browser. .TP .B findprevious @@ -747,7 +747,7 @@ .SH REBINDING KEYS .TP .B execute Prompts for a program to execute. The program's output is inserted -into the current buffer \(em or into a new buffer when \fBM\-F\fR is toggled. +into the current buffer \[em] or into a new buffer when \fBM\-F\fR is toggled. When the program's name is preceded by a pipe symbol (\fB|\fR), then the current buffer (or the marked region) is piped to the program, and the output of the program replaces the buffer (or the marked region). @@ -922,7 +922,7 @@ .SH REBINDING KEYS Deletes the character before the cursor. .TP .B recordmacro -Starts the recording of keystrokes \(em the keystrokes are stored +Starts the recording of keystrokes \[em] the keystrokes are stored as a macro. When already recording, the recording is stopped. .TP .B runmacro @@ -1037,7 +1037,7 @@ .SH REBINDING KEYS .TP .B autoindent Toggles whether a newly created line will contain the same amount of leading -whitespace as the preceding line \(em or as the next line if the preceding line +whitespace as the preceding line \[em] or as the next line if the preceding line is the beginning of a paragraph. .TP .B cutfromcursor -- 2.30.2
signature.asc
(application/pgp-signature, 833 B)
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEh3PWHWjjDgcrENwa0Z6cfXEmbc4FAmnqpBMACgkQ0Z6cfXEm bc5oIg//SaSWWa6lk+0qfvPNO+xr5pJEiAMeo5uoBnqVMIIT4ZVE7TKpG4OD4aQc dxDhTgstB6RLuS/Fgyux+wjnUsXu8oyl1H4jk24Tw53cJRaWnp02V54RsRAjSfUk Q1mTUqafRLtcrHJR5Ehdiq+28ucNSWK5m9ylTH14MKH8uGnvwNxpxe7oXcRqBtXG wlTEm8+3+oa2vfe5KWBt+qkME4qIerG05LmYOaLUAinCj2eKs8UCs9QCxIat2NCo MaUNwBi/Z6OjfiHl/09iMsRmPp9sk3Aln8b5K7OqIb92QhiIPV/XHW8n3+1wPP67 T65XsqiUQoH0A2T3qTnmv9+sRlrzUDbz1PxRtJ5kYlECs9kVgdMK9A/oIzhHvbyW NytLjoz7NJEtVyosHakVQPh1vTVtTJp+M7XIzOFCdRvXos5swOkx7mc8r5mvebWu VoXbSOOirQPg6m9F0PKwx0nN8qEJT4ZTE9JTzezUB2kTxwi5c2QDGZmXf7h1UcTI uBaheONJHUFx6yxdptUbnB0di28bWj6z9OYz3cqJXJd4SwaUIdzbsOOWiUz6tyfi PhuhDv+0le4LOUCV4oAcG0Hrk251lYJTDj7RAU9HCHOIfadrtWmFUDhW+NBCqAfj pBEZ5bEgkMA7+bpuHDUG/tLqXqVII9eSMo+3DvDWyDls+oJq+ew= =JXsh -----END PGP SIGNATURE-----