bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 08/23] man/*.{3x,1}: Canonicalize canonicity.


From: G. Branden Robinson
Subject: [PATCH 08/23] man/*.{3x,1}: Canonicalize canonicity.
Date: Thu, 26 Dec 2024 21:34:38 -0600

The proper term for "cooked" terminal mode is "canonical", hence the
stty(1) operand "icanon".
---
 man/curs_get_wch.3x |  2 +-
 man/curs_getch.3x   |  4 ++--
 man/curs_getstr.3x  |  2 +-
 man/curs_inopts.3x  | 12 ++++++------
 man/curs_mouse.3x   | 11 ++++++-----
 man/ncurses.3x      |  2 +-
 man/tput.1          |  2 +-
 man/tset.1          |  2 +-
 8 files changed, 19 insertions(+), 18 deletions(-)

diff --git a/man/curs_get_wch.3x b/man/curs_get_wch.3x
index f691530ed..c9db0ecf5 100644
--- a/man/curs_get_wch.3x
+++ b/man/curs_get_wch.3x
@@ -109,7 +109,7 @@ .SS "Reading Characters"
 If \fB\%nocbreak\fP(3X) or \fB\%noraw\fP(3X)
 has been called,
 it occurs when the next newline is read.
-(Because the terminal's normal or \*(``cooked\*('' mode
+(Because the terminal's canonical or \*(``cooked\*('' mode
 is line-buffered,
 multiple
 .B \%wget_wch
diff --git a/man/curs_getch.3x b/man/curs_getch.3x
index f4b023b02..d40bfaf9f 100644
--- a/man/curs_getch.3x
+++ b/man/curs_getch.3x
@@ -109,7 +109,7 @@ .SS "Reading Characters"
 If \fB\%nocbreak\fP(3X) or \fB\%noraw\fP(3X)
 has been called,
 it occurs when the next newline is read.
-(Because the terminal's normal or \*(``cooked\*('' mode
+(Because the terminal's canonical or \*(``cooked\*('' mode
 is line-buffered,
 multiple
 .B \%wgetch
@@ -558,7 +558,7 @@ .SH NOTES
 (raw,
 cbreak,
 or
-\*(``cooked\*(''),
+canonical),
 and whether \fB\%nl\fP(3X) or \fB\%nonl\fP(3X) has been called,
 .B \%wgetch
 may return either a carriage return or line feed upon an Enter or Return
diff --git a/man/curs_getstr.3x b/man/curs_getstr.3x
index 51b613a6d..8cb48b7f3 100644
--- a/man/curs_getstr.3x
+++ b/man/curs_getstr.3x
@@ -206,7 +206,7 @@ .SH NOTES
 .I curses
 screen to permit simple editing of the input buffer.
 It saves the screen's state and then calls \fBnl\fP(3X) and,
-if the screen was in normal (\*(``cooked\*('') mode,
+if the screen was in canonical (\*(``cooked\*('') mode,
 \fB\%cbreak\fP(3X).
 Before returning,
 it restores the saved screen state.
diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index cb4460dab..cb3c88ad1 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -147,7 +147,7 @@ .SS "cbreak, nocbreak"
 and makes characters typed by the user immediately available to the
 program.
 .B \%nocbreak
-restores the terminal's normal (\*(``cooked\*('') line discipline.
+restores the terminal's canonical (\*(``cooked\*('') line discipline.
 .PP
 The state of the terminal is unknown to a
 .I curses
@@ -328,7 +328,7 @@ .SS "nl, nonl"
 configures the terminal to perform this translation.
 .B nonl
 disables it.
-Under its normal (\*(``cooked\*('') line discipline,
+Under its canonical (\*(``cooked\*('') line discipline,
 the terminal driver always translates carriage returns to line feeds.
 .\"
 .SS nodelay
@@ -365,7 +365,7 @@ .SS "qiflush, noqiflush"
 configure the terminal driver's treatment of its input and output queues
 when it handles the interrupt,
 suspend,
-or quit characters under the normal (\*(``cooked\*('')
+or quit characters under the canonical (\*(``cooked\*('')
 or cbreak line disciplines on POSIX systems;
 see \fI\%termios\fP(3).
 The default behavior is inherited from the terminal driver settings.
@@ -412,7 +412,7 @@ .SS "raw, noraw"
 .I curses
 does not handle.
 .B \%noraw
-restores the terminal's normal (\*(``cooked\*('') line discipline.
+restores the terminal's canonical (\*(``cooked\*('') line discipline.
 .\"
 .SS "timeout, wtimeout"
 .B \%wtimeout
@@ -558,7 +558,7 @@ .SH NOTES
 and
 .B \%nocbreak
 follow historical practice in that they attempt to restore
-the terminal's normal (\*(``cooked\*('') line discipline
+the terminal's canonical (\*(``cooked\*('') line discipline
 from raw and cbreak,
 respectively.
 Mixing
@@ -642,7 +642,7 @@ .SH PORTABILITY
 or
 .B \%noecho
 explicitly just after initialization,
-even if your program retains the terminal's normal (\*(``cooked\*('')
+even if your program retains the terminal's canonical (\*(``cooked\*('')
 line discipline.
 .PP
 X/Open Curses is ambiguous regarding whether
diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index 6778b2420..60fd49b33 100644
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -93,10 +93,10 @@ .SS has_mouse
 has been successfully initialized,
 and \fBFALSE\fP otherwise.
 .PP
-Mouse events are ignored when input is in cooked mode, and
-cause an error beep when cooked mode is being simulated in a window by a
-function such as \fB\%getstr\fP that expects a linefeed for input-loop
-termination.
+Mouse events are ignored when input is in canonical (\*(``cooked\*('')
+mode, and cause an error beep when canonical mode is being simulated in
+a window by a function such as \fB\%getstr\fP that expects a linefeed
+for input-loop termination.
 .SS mousemask
 To make mouse events visible, use the \fB\%mousemask\fP function.
 This sets the mouse events to be reported.
@@ -488,7 +488,8 @@ .SH BUGS
 .I \%xterm
 are
 .I not
-ignored in cooked mode if they have been enabled by \fB\%mousemask\fP.
+ignored in canonical mode if they have been enabled by
+\fB\%mousemask\fP.
 Instead,
 the
 .I \%xterm
diff --git a/man/ncurses.3x b/man/ncurses.3x
index e015062b3..dd0813403 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -243,7 +243,7 @@ .SS Overview
 is in one of three modes:
 raw,
 \%cbreak,
-or normal (\*(``cooked\*('').
+or canonical (\*(``cooked\*('').
 In
 .IR curses ","
 the line discipline is a property of the screen,
diff --git a/man/tput.1 b/man/tput.1
index ffc4b1cd5..c6ff8b305 100644
--- a/man/tput.1
+++ b/man/tput.1
@@ -216,7 +216,7 @@ .SS Operands
 \fB\%@TPUT@\fP sets the the terminal modes to a \*(``sane\*('' state,
 .RS
 .bP
-enabling cooked and echo modes,
+enabling canonical (\*(``cooked\*('') and echo modes,
 .bP
 disabling cbreak and raw modes,
 .bP
diff --git a/man/tset.1 b/man/tset.1
index 8542bba43..5a139f53d 100644
--- a/man/tset.1
+++ b/man/tset.1
@@ -135,7 +135,7 @@ .SS "\fIreset\fP \(em reinitialization"
 When invoked as \fB@RESET@\fP, \fB@TSET@\fP sets the terminal
 modes to \*(``sane\*('' values:
 .bP
-sets cooked and echo modes,
+sets canonical (\*(``cooked\*('') and echo modes,
 .bP
 turns off cbreak and raw modes,
 .bP
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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