[PATCH 07/31] docs: employ `UR`, `UE`, `MT`, `ME` macros
"G. Branden Robinson" <[email protected]> Thu, 23 Apr 2026 17:58:10 -0500
| Newsgroups | gmane.editors.nano.devel |
|---|---|
| Message-ID | <20260423225810.f2b76duwxvog2fs5@illithid> |
groff and mandoc both have supported these macros for many years, and
recent versions of groff make them clickable hyperlinks on terminal and
PDF devices.
groff_man(7):
Hyperlink macros
...
MT, ME, UR, and UE are GNU extensions supported by Heirloom
Doctools troff (since Git snapshot 151218) and mandoc (UR/UE since
1.12.3; MT/ME since 1.14.2) but not by DWB, Plan 9 (original), or
Solaris troffs.
...
.MT address
.ME [trailing‐text]
Identify address as an RFC 6068 addr‐spec for a “mailto:”
URI with the text between the two macro calls as the link
text. An argument to ME is placed after the link text
without intervening space. address may not be visible in
the rendered document if hyperlinks are enabled and
supported by the output driver. If they are not, address is
set in angle brackets after the link text and before
trailing‐text. If hyperlinking is enabled but there is no
link text, address is formatted and hyperlinked without
angle brackets, except when address appears as a TP
paragraph tag.
.UR uri
.UE [trailing‐text]
Identify uri as an RFC 3986 URI hyperlink with the text
between the two macro calls as the link text. An argument
to UE is placed after the link text without intervening
space. uri may not be visible in the rendered document if
hyperlinks are enabled and supported by the output driver.
If they are not, uri is set in angle brackets after the link
text and before trailing‐text. If hyperlinking is enabled
but there is no link text, uri is formatted and hyperlinked
without angle brackets, except when uri appears as a TP
paragraph tag.
If a UR/UE or MT/ME pair occurs in a TP tag and hyperlinking is
unavailable, groff man sets the link target at the beginning of the
indented paragraph, not as part of the tag, unless there is no link
text.
...
History
...
Later, groff 1.20 (2009) resurrected EX/EE and originated SY/YS, TQ,
MT/ME, and UR/UE.
---
doc/nano.1 | 18 +++++++++++++-----
doc/nanorc.5 | 5 +++--
doc/rnano.1 | 8 ++++++--
3 files changed, 22 insertions(+), 9 deletions(-)
diff --git a/doc/nano.1 b/doc/nano.1
index cfdff8af..84d1c513 100644
--- a/doc/nano.1
+++ b/doc/nano.1
@@ -503,23 +503,31 @@ .SH NOTES
\fBnano\fR writes all open buffers to their respective emergency files.
.P
If you have any question about how to use \fBnano\fR in some specific
-situation, you can ask on \fIhelp\[email protected]\fR.
+situation, you can ask on
+.MT help\[email protected]
+the
+.I help-nano
+mailing list
+.ME .
.
.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.
.P
-Please report any other bugs that you encounter via:
-.br
-.IR https://savannah.gnu.org/bugs/?group=nano .
+Please report any other bugs that you encounter via
+.UR https://\:savannah\:.gnu\:.org/\:bugs/\:?group=nano
+.BR nano 's
+Savannah bug tracker
+.UE .
.P
When nano crashes, it saves any modified buffers to emergency .save files.
If you are able to reproduce the crash and you want to get a backtrace, define
the environment variable \fBNANO_NOCATCH\fR.
.
.SH HOMEPAGE
-.I https://nano\-editor.org/
+.UR https://nano\-editor.org/
+.UE
.
.SH SEE ALSO
.BR nanorc (5)
diff --git a/doc/nanorc.5 b/doc/nanorc.5
index eef5bced..cc8341f0 100644
--- a/doc/nanorc.5
+++ b/doc/nanorc.5
@@ -821,7 +821,7 @@ .SH REBINDING KEYS
while keeping the cursor in the same text position, if possible.
(This function is bound by default to \fBM-Up\fR.
If \fBM-Up\fR does nothing on your Linux console, see the FAQ:
-.UR https://nano\-editor.org/dist/latest/faq.html#4.1
+.UR https://\:nano\-editor.org/\:dist/\:latest/\:faq\:.html#4.1
.UE .)
.TP
.B scrolldown
@@ -1144,5 +1144,6 @@ .SH FILES
.SH SEE ALSO
.BR nano (1)
.TP
-.I https://nano\-editor.org/cheatsheet.html
+.UR https://\:nano\-editor\:.org/\:cheatsheet\:.html
+.UE
An overview of the default key bindings.
diff --git a/doc/rnano.1 b/doc/rnano.1
index c5b5e455..b8f3e8b1 100644
--- a/doc/rnano.1
+++ b/doc/rnano.1
@@ -57,10 +57,14 @@ .SH OPTIONS
.
.SH BUGS
Please report bugs via
-.IR https://savannah.gnu.org/bugs/?group=nano .
+.UR https://\:savannah\:.gnu\:.org/\:bugs/\:?group=nano
+.BR nano 's
+Savannah bug tracker
+.UE .
.
.SH HOMEPAGE
-.I https://nano-editor.org/
+.UR https://nano\-editor.org/
+.UE
.
.SH SEE ALSO
.BR nano (1)
--
2.30.2
signature.asc
(application/pgp-signature, 833 B)
-----BEGIN PGP SIGNATURE----- iQIzBAABCAAdFiEEh3PWHWjjDgcrENwa0Z6cfXEmbc4FAmnqpAIACgkQ0Z6cfXEm bc5IzBAAr/Nw6UufX/aYhmUj6iVe3Q2OMSSKnTM0t3lii2TDt9XrQp/kknPqHRwx mjOCy7dQuKaF+sHcAHpd7fOCdNaEZh2ypR26mQu6C6OjXSy/8ScnKgPEmyxvsN4O EBdUq6JqSPWCUgrl/LTBPCE0Uu2mvYYJbxMRXKr4H/SjDam+S7itLUMBLJmdCnQ6 elBnHYKySNVv65hOw5wm8pFGH3CYYj167yQTGgFBNyBpC05RWJWPcZHja2Yi/Bk7 +FSKUlr4bmz3REMbfUrsqcidRQm4g0z52s2fyfjrOMFf9bdYd1x7OpnnLJzGrLQm Gzyfy2MQzBz1mCINuhjLUhNEfdR1YnZt8fSkjMkGcW19EVhCYKPCdC2ZZgzQ80zR oRecZCNXgRC9Xhk2mMtQAC24cypvahUNrZuDm6uB0aBzGkBVO8FcBsZRc87rpikb VZxyMqYQr7hXY8hapA71Hses0ZwHWzbIE8WDZFgWeyGPhZzeXw+qqN59D0QETTKR 0Sx7DI/2kuiQYycAXGyn9kNSizIQT0Lq8E62fHs5XxiKDjUVx8dTUAcjFafnvAy7 5n07LwPh4vkYR4b/IimMsKz9+EIfa7ESJKUBAgVwv1lk0Pnwww/LG4QOrt4bnUN1 2LBYdubKV7XWgsdEL8U2lMy5WzAdfyWJrkELvVU0l0JOdyHRoWc= =JA/a -----END PGP SIGNATURE-----