bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 6/9] Style {n,}curses as elsewhere.


From: G. Branden Robinson
Subject: [PATCH 6/9] Style {n,}curses as elsewhere.
Date: Fri, 22 Sep 2023 12:59:11 -0500

That is, not capitalized; in italics (not bold); and not (repeatedly) as
a man page cross reference.

* man/curs_inopts.3x:
* man/curs_legacy.3x:
* man/curs_mouse.3x: Do it.
---
 man/curs_inopts.3x | 38 +++++++++++++++++++-------------------
 man/curs_legacy.3x |  2 +-
 man/curs_mouse.3x  | 22 +++++++++++-----------
 3 files changed, 31 insertions(+), 31 deletions(-)

diff --git a/man/curs_inopts.3x b/man/curs_inopts.3x
index e7859e7b..9f936500 100644
--- a/man/curs_inopts.3x
+++ b/man/curs_inopts.3x
@@ -97,7 +97,7 @@ .SH SYNOPSIS
 \fBint is_raw(void);\fP
 .nf
 .SH DESCRIPTION
-The \fBncurses\fP library provides several functions which let an application
+The \fIncurses\fP library provides several functions which let an application
 change the way input from the terminal is handled.
 Some are global, applying to all windows.
 Others apply only to a specific window.
@@ -119,7 +119,7 @@ .SS cbreak/nocbreak
 Initially the terminal may or may not be in \fB\%cbreak\fP mode, as the mode is
 inherited; therefore, a program should call \fB\%cbreak\fP or \fB\%nocbreak\fP
 explicitly.
-Most interactive programs using \fBcurses\fP set the \fB\%cbreak\fP
+Most interactive programs using \fIcurses\fP set the \fB\%cbreak\fP
 mode.
 Note that \fB\%cbreak\fP overrides \fBraw\fP.
 [See \fB\%curs_getch\fP(3X) for a
@@ -153,7 +153,7 @@ .SS intrflush
 If the \fB\%intrflush\fP option is enabled (\fIbf\fP is \fBTRUE\fP), and an
 interrupt key is pressed on the keyboard (interrupt, break, quit), all output 
in
 the tty driver queue will be flushed, giving the effect of faster response to
-the interrupt, but causing \fBcurses\fP to have the wrong idea of what is on
+the interrupt, but causing \fIcurses\fP to have the wrong idea of what is on
 the screen.
 Disabling the option (\fIbf\fP is \fBFALSE\fP) prevents the
 flush.
@@ -167,7 +167,7 @@ .SS keypad
 (such as an arrow key) and \fB\%wgetch\fP(3X) returns a single value
 representing the function key, as in \fB\%KEY_LEFT\fP.
 If disabled
-(\fIbf\fP is \fBFALSE\fP), \fBcurses\fP does not treat function keys
+(\fIbf\fP is \fBFALSE\fP), \fIcurses\fP does not treat function keys
 specially and the program has to interpret the escape sequences
 itself.
 If the keypad in the terminal can be turned on (made to
@@ -221,7 +221,7 @@ .SS raw/noraw
 passed through uninterpreted, instead of generating a signal.
 The behavior of
 the BREAK key depends on other bits in the tty driver that are not set by
-\fBcurses\fP.
+\fIcurses\fP.
 .\"
 .SS qiflush/noqiflush
 When the \fB\%noqiflush\fP routine is used, normal flush of input and
@@ -250,7 +250,7 @@ .SS timeout/wtimeout
 \fIdelay\fP milliseconds (where \fIdelay\fP is positive).
 .\"
 .SS typeahead
-The \fBcurses\fP library does \*(``line-breakout optimization\*(''
+The \fIcurses\fP library does \*(``line-breakout optimization\*(''
 by looking for typeahead periodically while updating the screen.
 If input is found, and it is coming from a tty,
 the current update is postponed until
@@ -304,20 +304,20 @@ .SH EXTENSIONS
 if the flag is reset, or
 .TP 5
 -1
-if the curses library was not initialized.
+if the \fIcurses\fP library was not initialized.
 .PP
-These routines are specific to ncurses.
+These routines are specific to \fIncurses\fP.
 They were not supported on Version 7, BSD or System V implementations.
-It is recommended that any code depending on ncurses extensions
+It is recommended that any code depending on \fIncurses\fP extensions
 be conditioned using NCURSES_VERSION.
 .SH PORTABILITY
 Except as noted in the section on extensions,
 these functions are described in the XSI Curses standard, Issue 4.
 .PP
-The ncurses library obeys the XPG4 standard and the historical practice of the
-AT&T curses implementations, in that the echo bit is cleared when curses
+The \fIncurses\fP library obeys the XPG4 standard and the historical practice 
of the
+AT&T \fIcurses\fP implementations, in that the echo bit is cleared when 
\fIcurses\fP
 initializes the terminal state.
-BSD curses differed from this slightly; it
+BSD \fIcurses\fP differed from this slightly; it
 left the echo bit on at initialization, but the BSD \fBraw\fP call turned it
 off as a side-effect.
 For best portability, set \fBecho \fPor \fB\%noecho\fP explicitly
@@ -325,24 +325,24 @@ .SH PORTABILITY
 .PP
 The XSI Curses standard is ambiguous on the question of whether \fBraw\fP
 should disable the CRLF translations controlled by \fBnl\fP and \fBnonl\fP.
-BSD curses did turn off these translations; AT&T curses (at least as late as
+BSD \fIcurses\fP did turn off these translations; AT&T \fIcurses\fP (at least 
as late as
 SVr1) did not.
 We chose to do so, on the theory that a programmer requesting
 raw input wants a clean (ideally 8-bit clean) connection that the operating
 system will not alter.
 .PP
 When \fB\%keypad\fP is first enabled,
-ncurses loads the key-definitions for the current terminal description.
+\fIncurses\fP loads the key-definitions for the current terminal description.
 If the terminal description includes extended string capabilities,
 e.g., from using the \fB\-x\fP option of \fB@TIC@\fP,
-then ncurses also defines keys for the capabilities whose names
+then \fIncurses\fP also defines keys for the capabilities whose names
 begin with \*(``k\*(''.
 The corresponding keycodes 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 function
 (which will then return a name beginning with \*(``k\*('' denoting the
-terminfo capability name rather than \*(``K\*('', used for curses key-names).
+terminfo capability name rather than \*(``K\*('', used for \fIcurses\fP 
key-names).
 On the other hand, an application can use \fB\%define_key\fP to establish
 a specific keycode for a given string.
 This makes it possible for an application to check for an extended
@@ -351,16 +351,16 @@ .SH PORTABILITY
 .PP
 Low-level applications can use \fB\%tigetstr\fP to obtain the definition
 of any particular string capability.
-Higher-level applications which use the curses \fB\%wgetch\fP
+Higher-level applications which use the \fIcurses\fP \fB\%wgetch\fP
 and similar functions to return keycodes rely upon the order in which
 the strings are loaded.
 If more than one key definition has the same string value,
 then \fB\%wgetch\fP can return only one keycode.
-Most curses implementations (including ncurses)
+Most \fIcurses\fP implementations (including \fIncurses\fP)
 load key definitions in the order
 defined by the array of string capability names.
 The last key to be loaded determines the keycode which will be returned.
-In ncurses, you may also have extended capabilities interpreted as
+In \fIncurses\fP, you may also have extended capabilities interpreted as
 key definitions.
 These are loaded after the predefined keys,
 and if a capability's value is the same as a previously-loaded
diff --git a/man/curs_legacy.3x b/man/curs_legacy.3x
index 3153d9a6..2049430a 100644
--- a/man/curs_legacy.3x
+++ b/man/curs_legacy.3x
@@ -63,7 +63,7 @@ .SH SYNOPSIS
 \fBint getpary(const WINDOW *\fIwin\fB);\fR
 .fi
 .SH DESCRIPTION
-These legacy functions are simpler to use than the X/Open Curses functions:
+These legacy functions are simpler to use than the X/Open \fIcurses\fP 
functions:
 .bP
 The \fB\%getattrs\fP function returns the same attribute data as 
\fB\%wattr_get\fP.
 .IP
diff --git a/man/curs_mouse.3x b/man/curs_mouse.3x
index 4647d35a..8101150e 100644
--- a/man/curs_mouse.3x
+++ b/man/curs_mouse.3x
@@ -274,10 +274,10 @@ .SH RETURN VALUE
 are boolean functions returning \fBTRUE\fP or \fBFALSE\fP depending
 on their test result.
 .SH PORTABILITY
-These calls were designed for \fBncurses\fP(3X), and are not found in SVr4
-curses, 4.4BSD curses, or any other previous version of curses.
+These calls were designed for \fIncurses\fP, and are not found in SVr4
+\fIcurses\fP, 4.4BSD \fIcurses\fP, or any other previous version of 
\fIcurses\fP.
 .PP
-SVr4 curses had support for the mouse in a variant of \fBxterm\fP(1).
+SVr4 \fIcurses\fP had support for the mouse in a variant of \fBxterm\fP(1).
 It is mentioned in a few places, but with no supporting documentation:
 .bP
 the \*(``libcurses\*('' manual page lists functions for this feature
@@ -301,20 +301,20 @@ .SH PORTABILITY
 req_mouse_pos     reqmp   RQ       Request mouse position report
 .NE
 .bP
-the interface made assumptions (as does ncurses) about the escape sequences
+the interface made assumptions (as does \fIncurses\fP) about the escape 
sequences
 sent to and received from the terminal.
 .IP
 For instance
-the SVr4 curses library used the \fB\%get_mouse\fP capability to tell the
+the SVr4 \fIcurses\fP library used the \fB\%get_mouse\fP capability to tell the
 terminal which mouse button events it should send,
 passing the mouse-button bit-mask to the terminal.
 Also, it could ask the terminal
 where the mouse was using the \fB\%req_mouse_pos\fP capability.
 .IP
-Those features required a terminal which had been modified to work with curses.
+Those features required a terminal which had been modified to work with 
\fIcurses\fP.
 They were not part of the X Consortium's xterm.
 .PP
-When developing the xterm mouse support for ncurses in September 1995,
+When developing the xterm mouse support for \fIncurses\fP in September 1995,
 Eric Raymond was uninterested in using the same interface due to its
 lack of documentation.
 Later, in 1998, Mark Hesseling provided support in
@@ -328,7 +328,7 @@ .SH PORTABILITY
 If the interface is changed, the value of \fB\%NCURSES_MOUSE_VERSION\fP will be
 incremented.
 These values for \fB\%NCURSES_MOUSE_VERSION\fP may be
-specified when configuring ncurses:
+specified when configuring \fIncurses\fP:
 .RS 3
 .TP 3
 1
@@ -344,7 +344,7 @@ .SH PORTABILITY
 The order of the \fB\%MEVENT\fP structure members is not guaranteed.
 Additional fields may be added to the structure in the future.
 .PP
-Under \fBncurses\fP(3X), these calls are implemented using either
+Under \fIncurses\fP, these calls are implemented using either
 xterm's built-in mouse-tracking API or
 platform-specific drivers including
 .RS 3
@@ -358,7 +358,7 @@ .SH PORTABILITY
 .PP
 If you are using an unsupported configuration,
 mouse events will not be visible to
-\fBncurses\fP(3X) (and the \fB\%mousemask\fP function will always
+\fIncurses\fP (and the \fB\%mousemask\fP function will always
 return \fB0\fP).
 .PP
 If the terminfo entry contains a \fBXM\fP string,
@@ -402,7 +402,7 @@ .SH BUGS
 i.e., it is the beginning of the response.
 .PP
 Because there are no standard terminal responses that would serve to identify
-terminals which support the xterm mouse protocol, \fBncurses\fP assumes that
+terminals which support the xterm mouse protocol, \fIncurses\fP assumes that
 if \fB\%kmous\fP is defined in the terminal description,
 or if the terminal description's primary name or aliases
 contain the string \*(``xterm\*('',
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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