bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 026/100] man/ncurses.3x: Recast "Initialization" subsection.


From: G. Branden Robinson
Subject: [PATCH 026/100] man/ncurses.3x: Recast "Initialization" subsection.
Date: Sat, 30 Mar 2024 16:51:22 -0500

Content:
* Promote mentions of ncurses functions to man page cross references.

Style:
* Protect man page topic names from hyphenation.
* Set example in roman, not bold; the text is already displayed and (on
  typesetters) in a monospaced font.
* Use em dashes instead of parentheses for an aside.
* Replace colon dangling at the end of a sentence with a period.  The
  subsequent use of a code display makes the structure clear.

Markup:
* Set external man page cross reference in italics, not roman.
* Use unbreakable space in "ISO 8859-1".
* Protect man page cross references from hyphenation.
---
 man/ncurses.3x | 37 +++++++++++++++++++------------------
 1 file changed, 19 insertions(+), 18 deletions(-)

diff --git a/man/ncurses.3x b/man/ncurses.3x
index 2e945c2de..769eedcec 100644
--- a/man/ncurses.3x
+++ b/man/ncurses.3x
@@ -170,43 +170,44 @@ .SH DESCRIPTION
 actions.
 See section \*(``ALTERNATE CONFIGURATIONS\*('' below.
 .SS Initialization
-The library uses the locale which the calling program has initialized.
-That is normally done with \fBsetlocale\fP(3):
+.I curses
+uses the locale initialized by the calling program.
+That is normally done with \fI\%setlocale\fP(3).
 .PP
 .RS 4
 .EX
-\fBsetlocale(LC_ALL, "");\fP
+setlocale(LC_ALL, "");
 .EE
 .RE
 .PP
 If the locale is not initialized,
-the library assumes that characters are printable as in ISO\-8859\-1,
+the library assumes that characters are printable as in ISO\ 8859-1,
 to work with certain legacy programs.
-You should initialize the locale and not rely on specific details of
-the library when the locale has not been set up.
+You should initialize the locale;
+do not expect consistent behavior from the library when the locale has
+not been set up.
 .PP
-The function \fBinitscr\fP or \fBnewterm\fP
-must be called to initialize the library
-before any of the other routines that deal with windows
-and screens are used.
-The routine \fBendwin\fP(3X) must be called before exiting.
+\fB\%initscr\fP(3X) or \fB\%newterm\fP(3X)
+must be called to initialize
+.I curses
+before use of any functions that deal with windows and screens.
+Call \fB\%endwin\fP(3X) before exiting the application.
 .PP
-To get character-at-a-time input without echoing (most
-interactive, screen oriented programs want this), the following
-sequence should be used:
+To get character-at-a-time input without echoing\(emmost interactive,
+screen-oriented programs want this\(emuse the following sequence.
 .PP
 .RS 4
 .EX
-\fBinitscr(); cbreak(); noecho();\fP
+initscr(); cbreak(); noecho();
 .EE
 .RE
 .PP
-Most programs would additionally use the sequence:
+Most applications perform further setup as follows.
 .PP
 .RS 4
 .EX
-\fBintrflush(stdscr, FALSE);\fP
-\fBkeypad(stdscr, TRUE);\fP
+intrflush(stdscr, FALSE);
+keypad(stdscr, TRUE);
 .EE
 .RE
 .SS Overview
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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