All of lore.kernel.org
 help / color / mirror / Atom feed
* [PATCH 2/2] man-pages.7: Update non-breaking space advice.
@ 2021-07-31  3:45 G. Branden Robinson
  2021-07-31 11:42 ` Alejandro Colomar (man-pages)
  0 siblings, 1 reply; 11+ messages in thread
From: G. Branden Robinson @ 2021-07-31  3:45 UTC (permalink / raw)
  To: linux-man; +Cc: Michael Kerrisk, Alejandro Colomar (man-pages)


[-- Attachment #1.1: Type: text/plain, Size: 1741 bytes --]

* Advise usage of \~ escape instead of \SPACE; the former, a groff
  extension from circa 1990, has been supported by Heirloom Doctools
  troff since 2005 and by mandoc since 2019.  The advantage is that
  \~ is an _adjustable_ non-breaking space, so it will typeset
  non-jarringly both in .EX/.EE examples when filling is off, and in
  normal running text (which is filled).
* Say "non-breaking" instead of "nonbreaking".  These are the only
  occurrences of either in the man-pages tree, except in Changes.old,
  which uses "non-breaking".

See linux-man@ list discussion at
<https://lore.kernel.org/linux-man/\
20210729115508.pt6btsqd7g5tuhg6@localhost.localdomain/> and follow-ups.
---
 man7/man-pages.7 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/man7/man-pages.7 b/man7/man-pages.7
index 3819dfd97..06dc7097c 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -686,14 +686,14 @@ man 7 man\-pages
 If the command is short, then it can be included inline in the text,
 in italic format, for example,
 .IR "man 7 man-pages" .
-In this case, it may be worth using nonbreaking spaces
-("\e\ ") at suitable places in the command.
+In this case, it may be worth using non-breaking spaces
+(\e\(ti) at suitable places in the command.
 Command options should be written in italics (e.g.,
 .IR \-l ).
 .PP
 Expressions, if not written on a separate indented line, should
 be specified in italics.
-Again, the use of nonbreaking spaces may be appropriate
+Again, the use of non-breaking spaces may be appropriate
 if the expression is inlined with normal text.
 .PP
 When showing example shell sessions, user input should be formatted in bold, for example
-- 
2.20.1


[-- Attachment #1.2: 0002-man-pages.7-Update-non-breaking-space-advice.patch --]
[-- Type: text/x-diff, Size: 1983 bytes --]

From 302aa3a0f2e5f0c3e9188936d4b0a25761ff5fd7 Mon Sep 17 00:00:00 2001
From: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Date: Sat, 31 Jul 2021 13:30:58 +1000
Subject: [PATCH 2/2] man-pages.7: Update non-breaking space advice.

* Advise usage of \~ escape instead of \SPACE; the former, a groff
  extension from circa 1990, has been supported by Heirloom Doctools
  troff since 2005 and by mandoc since 2019.  The advantage is that
  \~ is an _adjustable_ non-breaking space, so it will typeset
  non-jarringly both in .EX/.EE examples when filling is off, and in
  normal running text (which is filled).
* Say "non-breaking" instead of "nonbreaking".  These are the only
  occurrences of either in the man-pages tree, except in Changes.old,
  which uses "non-breaking".

See linux-man@ list discussion at
<https://lore.kernel.org/linux-man/\
20210729115508.pt6btsqd7g5tuhg6@localhost.localdomain/> and follow-ups.
---
 man7/man-pages.7 | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/man7/man-pages.7 b/man7/man-pages.7
index 3819dfd97..06dc7097c 100644
--- a/man7/man-pages.7
+++ b/man7/man-pages.7
@@ -686,14 +686,14 @@ man 7 man\-pages
 If the command is short, then it can be included inline in the text,
 in italic format, for example,
 .IR "man 7 man-pages" .
-In this case, it may be worth using nonbreaking spaces
-("\e\ ") at suitable places in the command.
+In this case, it may be worth using non-breaking spaces
+(\e\(ti) at suitable places in the command.
 Command options should be written in italics (e.g.,
 .IR \-l ).
 .PP
 Expressions, if not written on a separate indented line, should
 be specified in italics.
-Again, the use of nonbreaking spaces may be appropriate
+Again, the use of non-breaking spaces may be appropriate
 if the expression is inlined with normal text.
 .PP
 When showing example shell sessions, user input should be formatted in bold, for example
-- 
2.20.1


[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 833 bytes --]

^ permalink raw reply related	[flat|nested] 11+ messages in thread

end of thread, other threads:[~2021-11-12 20:33 UTC | newest]

Thread overview: 11+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2021-07-31  3:45 [PATCH 2/2] man-pages.7: Update non-breaking space advice G. Branden Robinson
2021-07-31 11:42 ` Alejandro Colomar (man-pages)
2021-08-01 10:12   ` G. Branden Robinson
2021-08-01 10:49     ` Alejandro Colomar (man-pages)
2021-08-01 11:41       ` G. Branden Robinson
2021-08-01 12:30         ` Alejandro Colomar (man-pages)
2021-08-04  6:20           ` G. Branden Robinson
2021-08-03  7:36         ` NeoMutt + GMail signed patches (was Re: [PATCH 2/2] man-pages.7: Update non-breaking space advice.) Alejandro Colomar (man-pages)
2021-08-03  9:34           ` наб
2021-10-17 19:53     ` [PATCH 2/2] man-pages.7: Update non-breaking space advice Alejandro Colomar (man-pages)
2021-11-12 20:33       ` Ping^2: " Alejandro Colomar (man-pages)

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.