bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 06/12] man/curs_legacy.3x: Revise "NAME" section.


From: G. Branden Robinson
Subject: [PATCH 06/12] man/curs_legacy.3x: Revise "NAME" section.
Date: Thu, 14 Sep 2023 07:48:46 -0500

Rewrite summary description.  (1) Use the names of the API symbols
exposed by the library, so that these will be indexed by makewhatis/
mandb and users can find them (no one will look for "curs_legacy".  (2)
Set these symbol names in bold for consistency with other ncurses man
pages even though this is uncommon in the "NAME" sections of man pages.
(3) Protect these literals from hyphenation.  (4)  Use man(7) font macro
to style the word "curses", as is (inconsistently) done in other ncurses
man pages (albeit in bold and with escape sequences instead--changes for
consistency are forthcoming).  (5) Wrap long input lines.  I am unaware
of a makewhatis/mandb so stupid that it can't make sense of line breaks
in "NAME" sections, and no formatter proper (*roff, mandoc(1)) should
have any problem with this--lines fill normally. (6) Mark these symbols
as legacy to deter the conscientious user who may now find the page.
---
 man/curs_legacy.3x | 12 +++++++++++-
 1 file changed, 11 insertions(+), 1 deletion(-)

diff --git a/man/curs_legacy.3x b/man/curs_legacy.3x
index 5eaee795..44c565f3 100644
--- a/man/curs_legacy.3x
+++ b/man/curs_legacy.3x
@@ -34,7 +34,17 @@
 ..
 .TH curs_legacy 3X 2023-07-01 "ncurses 6.4" "Library calls"
 .SH NAME
-curs_legacy \- get \fBcurses\fP cursor and window coordinates, attributes
+\fB\%getattrs\fP,
+\fB\%getbegx\fP,
+\fB\%getbegy\fP,
+\fB\%getcurx\fP,
+\fB\%getcury\fP,
+\fB\%getmaxx\fP,
+\fB\%getmaxy\fP,
+\fB\%getparx\fP,
+\fB\%getpary\fP \- get
+.I curses
+cursor and window coordinates or attributes (legacy)
 .SH SYNOPSIS
 \fB#include <curses.h>\fP
 .sp
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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