bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 032/100] man/ncurses.3x: Recast "Naming Conventions" section.


From: G. Branden Robinson
Subject: [PATCH 032/100] man/ncurses.3x: Recast "Naming Conventions" section.
Date: Sat, 30 Mar 2024 16:52:18 -0500

---
 man/ncurses.3x | 51 ++++++++++++++------------------------------------
 1 file changed, 14 insertions(+), 37 deletions(-)

diff --git a/man/ncurses.3x b/man/ncurses.3x
index b955f2119..83289cdf2 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -381,43 +381,20 @@ .SS "Initialization"
 .PP
 See section \*(``ENVIRONMENT\*('' below.
 .SS "Naming Conventions"
-Many
 .I curses
-functions have two or more versions.
-Those prefixed with \*(``w\*('' require a window argument.
-Four functions prefixed with \*(``p\*('' require a pad argument.
-Those without a prefix generally operate on \fB\%stdscr\fP.
-.PP
-As a rule,
-window-addressing functions feature names prefixed
-(or infixed,
-see below)
-with \*(``w\*('';
-these allow the user to specify a pointer to a
-.IR \%WINDOW .
-Counterparts not thus prefixed
-(or infixed)
-affect \fB\%stdscr\fP.
-Because moving the cursor prior to another operation is so common,
-.I curses
-generally also provides functions with a \*(``mv\*('' prefix as a
-convenience.
-Thus,
-the library defines all of
-\fB\%addch\fP,
-\fB\%waddch\fP,
-\fB\%mvaddch\fP,
-and
-\fB\%mvwaddch\fP.
-When both prefixes are present,
-the order of arguments is a
+offers many functions in variant forms using a regular set of
+alternatives to the name of an elemental one.
+Those prefixed with \*(``w\*('' require a
 .I \%WINDOW
-pointer first,
-then a
-.I y
-and
-.I x
-coordinate pair.
+pointer argument;
+those with a \*(``mv\*('' prefix first perform cursor movement using
+\fB\%wmove\fP(3X);
+a \*(``mvw\*('' prefix indicates both.
+The \*(``w\*('' function is typically the elemental one;
+the removal of this prefix usually indicates operation on
+.BR \%stdscr .
+.PP
+Four functions prefixed with \*(``p\*('' require a pad argument.
 .PP
 In function synopses,
 .I \%ncurses
@@ -427,8 +404,8 @@ .SS "Naming Conventions"
 center;
 Li L.
 bf     \fIbool\fP (\fBTRUE\fP or \fBFALSE\fP)
-win    pointer to \fIWINDOW\fP
-pad    pointer to \fIWINDOW\fP that is a pad
+win    pointer to a \fIWINDOW\fP
+pad    pointer to a \fIWINDOW\fP that is a pad
 .TE
 .SS "Wide and Non-wide Character Configurations"
 This manual page describes functions that appear in any configuration
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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