bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 18/22] man/curs_inopts.3x: Fix content and style nits.


From: G. Branden Robinson
Subject: [PATCH 18/22] man/curs_inopts.3x: Fix content and style nits.
Date: Sat, 1 Jun 2024 15:24:12 -0500

* Explicitly say what mode `noraw()` returns to.  This makes it easier
  for the curses programmer to understand that they can switch between
  raw and cbreak modes as long as they transition through cooked mode
  first.
* Spell "key code" thus, as two words.
* Elevate a parenthetical to an ordinary dependent clause.
* Simplify wording.
---
 man/curs_inopts.3x | 15 +++++++--------
 1 file changed, 7 insertions(+), 8 deletions(-)

diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index e915023b5..c22948bab 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -410,7 +410,7 @@ .SS "raw, noraw"
 .I curses
 does not handle.
 .B \%noraw
-exits raw mode.
+returns the terminal to normal (\*(``cooked\*('') mode.
 .\"
 .SS "timeout, wtimeout"
 .B \%wtimeout
@@ -678,20 +678,19 @@ .SH PORTABILITY
 Corresponding key codes are generated and
 (depending on previous loads of terminal descriptions)
 may differ from one execution of a program to the next.
-The generated keycodes are recognized by the \fB\%keyname\fP(3X)
-function
-(which then returns a name beginning with \*(``k\*('' denoting the
+The generated key codes are recognized by \fB\%keyname\fP(3X),
+which then returns a name beginning with \*(``k\*('' denoting the
 .I \%term\%info
 capability name rather than \*(``K\*('',
 used for
 .I curses
-key names).
+key names.
 On the other hand,
 an application can use \fB\%define_key\fP(3X) to bind
 a specific key to a string of the programmer's choice.
-This feature enables an application to check for an extended
-capability's presence with \fB\%tigetstr\fP(3X),
-and reassign the keycode to match its own needs.
+This feature enables an application to check for its presence
+with \fB\%tigetstr\fP(3X),
+and reassign the key code to match its own needs.
 .PP
 Low-level applications can use \fB\%tigetstr\fP(3X) to obtain the
 definition of any string capability.
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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