bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 21/42] man/panel.3x: Fix hyphenation consistency nit.


From: G. Branden Robinson
Subject: [PATCH 21/42] man/panel.3x: Fix hyphenation consistency nit.
Date: Sat, 16 Dec 2023 11:45:10 -0600

Elsewhere, we don't protect the English word "curses" from hyphenation
when using it as the name of a library (but we do as part of a file
name, "curses.h").  Stop doing so here, more for consistency than out of
deep principle.

The idea behind protecting ordinary English words from hyphenation is to
avoid user frustration when *roff's automatic hyphenation is enabled (as
it is by default) and man page content is likely to be copied-and-
pasted.  Broadly, this is true of "literals" but not of other material.

In man pages, I protect non-English words from hyphenation more
aggressively because it's hard to predict how the automatic hyphenation
patterns will treat them.  It is distracting to the reader to hyphenate
a word in a surprising place.  Often, the names of software projects
break ordinary English rules of morphology with abandon, and automatic
hyphenation algorithms rely on these to some degree.  (GNU and AT&T
troffs use completely different automatic hyphenation systems in any
case.)
---
 man/panel.3x | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/man/panel.3x b/man/panel.3x
index 81ad61c66..61bcaa447 100644
--- a/man/panel.3x
+++ b/man/panel.3x
@@ -46,7 +46,7 @@
 ..
 .SH NAME
 panel \-
-panel stack extension for \fI\%curses\fP
+panel stack extension for \fIcurses\fP
 .SH SYNOPSIS
 .nf
 \fB#include <panel.h>
@@ -80,7 +80,7 @@ .SH DESCRIPTION
 Panels are \fBcurses\fP(3X) windows with the added property of
 depth.
 Panel functions allow the use of stacked windows and ensure that the
-proper portions of each window and the \fI\%curses\fP \fB\%stdscr\fP
+proper portions of each window and the \fIcurses\fP \fB\%stdscr\fP
 window are hidden or displayed when panels are added,
 moved,
 modified,
@@ -97,9 +97,9 @@ .SH DESCRIPTION
 and show panels.
 You can relocate a panel to any desired position in the stack.
 .PP
-Panel routines are a functional layer added to \fI\%curses\fP,
-make only high-level \fI\%curses\fP calls,
-and work anywhere \fI\%curses\fP does.
+Panel routines are a functional layer added to \fIcurses\fP,
+make only high-level \fIcurses\fP calls,
+and work anywhere \fIcurses\fP does.
 .SH FUNCTIONS
 .\" ---------
 .SS bottom_panel
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]