[PATCH 28/31] docs: downcase man page identifiers, section heads
"G. Branden Robinson" <[email protected]> Thu, 23 Apr 2026 18:01:27 -0500
| Newsgroups | gmane.editors.nano.devel |
|---|---|
| Message-ID | <20260423230127.etgngqr6vysomvrz@illithid> |
Readers who prefer full capitals for these data can exercise a groff
1.23.0 feature to obtain them.
Options
The following groff options set registers (with -r) and strings
(with -d) recognized and used by the man macro package. To ensure
rendering consistent with output device capabilities and reader
preferences, man pages should never manipulate them.
...
-rCS=1 Set section headings (the argument(s) to SH) in full
capitals. This transformation is off by default because
it discards lettercase distinctions.
-rCT=1 Set the man page identifier (the first argument to TH) in
full capitals in headers and footers. This transformation
is off by default because it discards lettercase
distinctions.
...
groff users can also specify them in the "man.local" file.
/use/local/share/groff/site-tmac/man.local
Put site‐local changes and customizations into this file.
.\" Put only one space after the end of a sentence.
.ss 12 0 \" See groff(7).
.\" Keep pages narrow even on wide terminals.
.if n .if \n[LL]>80n .nr LL 80n
On multi‐user systems, it is more considerate to users whose
preferences may differ from the administrator’s to be less
aggressive with such settings, or to permit their override
with a user‐specific man.local file. Place the requests
below at the end of the site‐local file to manifest
courtesy.
.soquiet \V[XDG_CONFIG_HOME]/man.local
.soquiet \V[HOME]/.man.local
However, a security‐sandboxed man(1) program may lack
permission to open such files.
And man-db man(1) users can specify them in the `MANROFFOPT` environment
variable.
---
doc/nano.1 | 20 ++++++++++----------
doc/nanorc.5 | 14 +++++++-------
doc/rnano.1 | 14 +++++++-------
3 files changed, 24 insertions(+), 24 deletions(-)
diff --git a/doc/nano.1 b/doc/nano.1
index 5bf55845..5fef601a 100644
--- a/doc/nano.1
+++ b/doc/nano.1
@@ -16,14 +16,14 @@
.\" Documentation License along with this program. If not, see
.\" <https://www.gnu.org/licenses/>.
.\"
-.TH NANO 1 "April 2026" "nano 9.0"
+.TH nano 1 "April 2026" "nano 9.0"
.
-.SH NAME
+.SH Name
nano \- Nano's ANOther text editor, inspired by Pico
.
.hw ncurses quickblank
.
-.SH SYNOPSIS
+.SH Synopsis
.SY nano
.RI [ options ]
.RB [[ +\c
@@ -42,7 +42,7 @@ .SH SYNOPSIS
.IR file ].\|.\|.
.YS
.
-.SH DESCRIPTION
+.SH Description
.SS Notices
Since version 9.0, all lines are scrolled horizontally together
(when the cursor approaches the edge), by just the amount needed,
@@ -139,7 +139,7 @@ .SS Editing
The default key bindings can be changed via a \fInanorc\fR file \[em] see
.BR nanorc (5).
.
-.SH OPTIONS
+.SH Options
.TP
.B \-A
.TQ
@@ -583,7 +583,7 @@ .SS Toggles
the help viewer and the linter. All other toggles work in
the main menu only.
.
-.SH FILES
+.SH Files
When \fB\-\-rcfile\fR is given, \fBnano\fR reads just the specified file
for setting its options and syntaxes and key bindings. Without that
option, \fBnano\fR reads two configuration files: first the system's
@@ -596,7 +596,7 @@ .SH FILES
See \fI/usr/\:share/\:nano/\fR and \fI/\:usr/\:share/\:nano/\:extra/\fR
for available syntax-coloring definitions.
.
-.SH EXIT STATUS
+.SH Exit status
.TP
.B 0
The editor finished normally.
@@ -607,7 +607,7 @@ .SH EXIT STATUS
.B 2
The last open buffer was discarded (with \fB\[ha]O\[ha]Q\fR or \fB\[ha]X\[ha]Q\fR).
.
-.SH NOTES
+.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
\[lq]\fBbind \[ha]Z suspend main\fR\[rq] to your \fInanorc\fR.)
@@ -641,7 +641,7 @@ .SH NOTES
mailing list
.ME .
.
-.SH BUGS
+.SH Bugs
The recording and playback of keyboard macros works correctly only on a
terminal emulator, not on a Linux console (VT), because the latter does
not by default distinguish modified from unmodified arrow keys.
@@ -656,7 +656,7 @@ .SH BUGS
If you are able to reproduce the crash and you want to get a backtrace, define
the environment variable \%\fINANO_NOCATCH\fR.
.
-.SH SEE ALSO
+.SH See also
.SS Homepage
.UR https://nano\-editor.org/
.UE
diff --git a/doc/nanorc.5 b/doc/nanorc.5
index 503cb03a..54d7e314 100644
--- a/doc/nanorc.5
+++ b/doc/nanorc.5
@@ -16,14 +16,14 @@
.\" Documentation License along with this program. If not, see
.\" <https://www.gnu.org/licenses/>.
.\"
-.TH NANORC 5 "April 2026" "nano 9.0"
+.TH nanorc 5 "April 2026" "nano 9.0"
.
-.SH NAME
+.SH Name
nanorc \- GNU nano's configuration file
.
.hw constantshow ncurses quickblank stateflags titlecolor
.
-.SH DESCRIPTION
+.SH Description
The \fInanorc\fR files contain the default settings for \fBnano\fR,
a small and friendly text editor. During startup, if \fB\-\-rcfile\fR
is not given, \fBnano\fR reads two files: first the system-wide settings,
@@ -67,7 +67,7 @@ .SS Notices
.EE
.RE
.
-.SH OPTIONS
+.SH Options
The configuration file accepts a series of \fBset\fR and \fBunset\fR
commands, which can be used to configure \fBnano\fR on startup without using
command-line options. Additionally, there are some commands to define
@@ -1113,7 +1113,7 @@ .SS "Rebinding keys"
for \fBunbind\fR it means all menus where the specified \fIkey\fR exists.
.RE
.
-.SH EXAMPLES
+.SH Examples
To make \fBCtrl+Z\fR suspend \fBnano\fR:
.P
.RS
@@ -1130,7 +1130,7 @@ .SH EXAMPLES
.EE
.RE
.
-.SH FILES
+.SH Files
.TP
.I /etc/nanorc
System-wide configuration file.
@@ -1146,7 +1146,7 @@ .SH FILES
Syntax definitions for the syntax coloring of common file types
(and for less common file types in the \fIextra/\fR subdirectory).
.
-.SH SEE ALSO
+.SH See also
.BR nano (1)
.TP
.UR https://\:nano\-editor\:.org/\:cheatsheet\:.html
diff --git a/doc/rnano.1 b/doc/rnano.1
index 6032a1d8..b7c78fc0 100644
--- a/doc/rnano.1
+++ b/doc/rnano.1
@@ -16,12 +16,12 @@
.\" Documentation License along with this program. If not, see
.\" <https://www.gnu.org/licenses/>.
.\"
-.TH RNANO 1 "April 2026" "nano 9.0"
+.TH rnano 1 "April 2026" "nano 9.0"
.
-.SH NAME
+.SH Name
rnano \- a restricted nano
.
-.SH SYNOPSIS
+.SH Synopsis
.SY rnano
.RI [ options ]
.RB [[ +\c
@@ -40,7 +40,7 @@ .SH SYNOPSIS
.IR file ].\|.\|.
.YS
.
-.SH DESCRIPTION
+.SH Description
\fBrnano\fR runs the \fBnano\fR editor in restricted mode. This allows
editing only the specified file or files, and doesn't allow the user
access to the filesystem nor to a command shell.
@@ -61,7 +61,7 @@ .SH DESCRIPTION
.IP \[bu]
not allow appending or prepending to any file.
.
-.SH OPTIONS
+.SH Options
.TP
.B \-h
.TQ
@@ -70,14 +70,14 @@ .SH OPTIONS
.P
For all existing options, see the \fBnano\fR(1) man page.
.
-.SH BUGS
+.SH Bugs
Please report bugs via
.UR https://\:savannah\:.gnu\:.org/\:bugs/\:?group=nano
.BR nano 's
Savannah bug tracker
.UE .
.
-.SH SEE ALSO
+.SH See also
.SS Homepage
.UR https://nano\-editor.org/
.UE
--
2.30.2
signature.asc
(application/pgp-signature, 833 B)
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEh3PWHWjjDgcrENwa0Z6cfXEmbc4FAmnqpMcACgkQ0Z6cfXEm bc7IGBAAiKafDs5h+eup6uINWTYRl0wySq6dxgV/ZSwi0ElPoL5s10guCE+GY6PZ iPJ/r2R+joZyxFvDkaoqoChJVocRmsewXeKQTtbSJa0rtmOAFXupaRuXJyFu8HYm cEjo68JgKIfi7Z03IGEaslEdBZ2LVovszPxuxKZjtxNn/ovBlXzGEzS4h8fmabcp EkBiLPTEj8VmSlE6P4Gk2biR2Kbfc6loZz3Tag+qwvgfVTPQwQEuB1HvD8VeZmNV H9JPbL62aseel/ROGvjrD3YM0i74NCijGpZKP0/yC3/Q31YjCwzaUUaHH1y+BCI9 QfGhyIpACaUvCY7ZDXcT5MngKSu1+hKke7DVM8TqMR8bkzD/c87gjf+rGGJRJrLO lujeEJnhq4s0nKBEhMghd6GMddr/JhkIdCQ1gVJ1byETYntXdYbUxbamkbx6VYPT W9jtF/XYf4N2XjInMDsPAIxjx7R0z7VnAQoeQGr8zDsl/zEew1k4hIyJ5UUowI2J AmQWbQ1a732imZcCzoqLhxzkKSSfCBHZL0W1kmtCURoInqV8yiPd07R65mhQ4RHw 5vimR5nGnaL5v2ZTS6iOzWa1A3lh24uZAkWXtk8c5V8PdId0UcQvUq2hujeMD1A4 JvPWZPb5zzu7TmtXFU6o/3/QyVWfoqXHpJLiCv2YNA6kY7uqtww= =IQnO -----END PGP SIGNATURE-----