[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 11/23] man/curs_terminfo.3x: Revise "SYNOPSIS" section.
From: |
G. Branden Robinson |
Subject: |
[PATCH 11/23] man/curs_terminfo.3x: Revise "SYNOPSIS" section. |
Date: |
Thu, 26 Dec 2024 21:35:07 -0600 |
* Put a space after pointer stars, for consistency with other recently
edited ncurses man pages.
* Break long synopses across lines where they exceed 65 columns on nroff
devices. This was the line length used by AT&T troff (and BSD troff
until they adopted groff in their Net/2 release), and is, in my
opinion, the minimum line length one can expect to look nice. groff
1.24 is expected to feature enhanced `SY`/`YS` macros that work as
well with C function declarations as command-line syntax. Perhaps
we can inline their definitions in the ncurses man pages (which need
to be portable to legacy Unix systems) after they've seen more field
testing.
* Spell ellipsis better for typesetting scenarios. See
groff_man_style(7).
---
man/curs_terminfo.3x | 41 ++++++++++++++++++++++-------------------
1 file changed, 22 insertions(+), 19 deletions(-)
diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index 6dcfc8b8d..966c28622 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -70,7 +70,7 @@ .SH SYNOPSIS
\fB#include <curses.h>
\fB#include <term.h>
.PP
-\fBTERMINAL *cur_term;
+\fBTERMINAL * cur_term;
.PP
\fBconst char * const boolnames[];
\fBconst char * const boolcodes[];
@@ -82,35 +82,38 @@ .SH SYNOPSIS
\fBconst char * const strcodes[];
\fBconst char * const strfnames[];
.PP
-\fBint setupterm(const char *\fIterm\fP, int \fIfiledes\fP, int *\fIerrret\fP);
-\fBTERMINAL *set_curterm(TERMINAL *\fInterm\fP);
-\fBint del_curterm(TERMINAL *\fIoterm\fP);
-\fBint restartterm(const char *\fIterm\fP, int \fIfiledes\fP, int
*\fIerrret\fP);
+\fBint setupterm(const char * \fIterm\fP, int \fIfiledes\fP, int *
\fIerrret\fP);
+\fBTERMINAL * set_curterm(TERMINAL * \fInterm\fP);
+\fBint del_curterm(TERMINAL * \fIoterm\fP);
+\fBint restartterm(const char * \fIterm\fP, int \fIfiledes\fP,
+ int * \fIerrret\fP);
.PP
-\fBchar *tparm(const char *\fIstr\fP, \fR.\|.\|.\fP);
+\fBchar * tparm(const char * \fIstr\fP, \fR.\|.\|.\fP);
\fI/* or */
-\fBchar *tparm(const char *\fIstr\fP, long \fIp1\fP \fR.\|.\|.\fP \fBlong\fP
\fIp9\fP);
+\fBchar * tparm(const char * \fIstr\fP, long \fIp1\fP \fR.\|.\|.\fP \fBlong\fP
\fIp9\fP);
.PP
-\fBint tputs(const char *\fIstr\fP, int \fIaffcnt\fP, int (*\fIputc\fP)(int));
-\fBint putp(const char *\fIstr\fP);
+\fBint tputs(const char * \fIstr\fP, int \fIaffcnt\fP, int (*
\fIputc\fP)(int));
+\fBint putp(const char * \fIstr\fP);
.PP
-\fBint vidputs(chtype \fIattrs\fP, int (*\fIputc\fP)(int));
+\fBint vidputs(chtype \fIattrs\fP, int (* \fIputc\fP)(int));
\fBint vidattr(chtype \fIattrs\fP);
-\fBint vid_puts(attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP, int
(*\fIputc\fP)(int));
-\fBint vid_attr(attr_t \fIattrs\fP, short \fIpair\fP, void *\fIopts\fP);
+\fBint vid_puts(attr_t \fIattrs\fP, short \fIpair\fP, void * \fIopts\fP,
+ int (* \fIputc\fP)(int));
+\fBint vid_attr(attr_t \fIattrs\fP, short \fIpair\fP, void * \fIopts\fP);
.PP
-\fBint tigetflag(const char *\fIcap-code\fP);
-\fBint tigetnum(const char *\fIcap-code\fP);
-\fBchar *tigetstr(const char *\fIcap-code\fP);
+\fBint tigetflag(const char * \fIcap-code\fP);
+\fBint tigetnum(const char * \fIcap-code\fP);
+\fBchar * tigetstr(const char * \fIcap-code\fP);
.PP
-\fBchar *tiparm(const char *\fIstr\fP, \fR.\|.\|.\fP);
+\fBchar * tiparm(const char * \fIstr\fP, \fR.\|.\|.\fP);
.PP
\fI/* extensions */
-\fBchar *tiparm_s(int \fIexpected\fP, int \fImask\fP, const char *\fIstr\fP,
...);
-\fBint tiscan_s(int *\fIexpected\fP, int *\fImask\fP, const char *\fIstr\fP);
+\fBchar * tiparm_s(int \fIexpected\fP, int \fImask\fP,
+ const char * \fIstr\fP, .\|.\|.);
+\fBint tiscan_s(int * \fIexpected\fP, int * \fImask\fP, const char *
\fIstr\fP);
.PP
\fI/* deprecated */
-\fBint setterm(const char *\fIterm\fP);
+\fBint setterm(const char * \fIterm\fP);
.fi
.SH DESCRIPTION
These low-level functions must be called by programs that deal directly
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 11/23] man/curs_terminfo.3x: Revise "SYNOPSIS" section.,
G. Branden Robinson <=