[PATCH 17/42] man/ncurses.3x: Revise "Routine and Argument Names" section.

[G. Branden Robinson]

* Recast.
* Convert several sentences into a more compact table.
* Drop inapposite content about where types are defined.  The man page
  synopses are better at documenting this than they used to be.
---
 man/ncurses.3x | 48 +++++++++++++++++++-----------------------------
 1 file changed, 19 insertions(+), 29 deletions(-)

diff --git a/man/ncurses.3x b/man/ncurses.3x
index 24207fefd..5b830e0c9 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -342,35 +342,25 @@ .SS "Effects of GUIs and Environment Variables"
 permission to \fI\*d\fP is not available.
 .PP
 See section \*(``ENVIRONMENT\*('' below.
-.SS Routine and Argument Names
-Many \fBcurses\fP routines have two or more versions.
-The routines prefixed with \fIw\fP require a window argument.
-The routines prefixed with \fIp\fP require a pad argument.
-Those without a prefix generally use \fBstdscr\fP.
-.PP
-The routines prefixed with \fBmv\fP require a \fIy\fP and \fIx\fP
-coordinate to move to before performing the appropriate action.
-The \fBmv\fP routines imply a call to \fBmove\fP before the call to the
-other routine.
-The coordinate \fIy\fP always refers to the row (of
-the window), and \fIx\fP always refers to the column.
-The upper left-hand corner is always (0,0), not (1,1).
-.PP
-The routines prefixed with \fBmvw\fP take both a window argument and
-\fIx\fP and \fIy\fP coordinates.
-The window argument is always specified before the coordinates.
-.PP
-In each case, \fIwin\fP is the window affected, and \fIpad\fP is the
-pad affected; \fIwin\fP and \fIpad\fP are always pointers to type
-\fBWINDOW\fP.
-.PP
-Option setting routines require a Boolean flag \fIbf\fP with the value
-\fBTRUE\fP or \fBFALSE\fP; \fIbf\fP is always of type \fBbool\fP.
-Most of the data types used in the library routines,
-such as \fBWINDOW\fP, \fBSCREEN\fP, \fBbool\fP, and \fBchtype\fP
-are defined in \fB<curses.h>\fP.
-Types used for the terminfo routines such as
-\fBTERMINAL\fP are defined in \fB<term.h>\fP.
+.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
+In function synopses,
+.I \%ncurses
+man pages apply the following names to parameters.
+.PP
+.TS
+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
+.TE
 .SS "Wide and Non-wide Character Configurations"
 This manual page describes functions that appear in any configuration
 of the library.
-- 
2.30.2

signature.asc
Description: PGP signature