bug-ncurses
[Top][All Lists]
Advanced

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

[PATCH 34/40] man/curs_border{,_set}.3x: Revise synopses.


From: G. Branden Robinson
Subject: [PATCH 34/40] man/curs_border{,_set}.3x: Revise synopses.
Date: Sat, 1 Feb 2025 11:34:27 -0600

Break long synopses across lines where it exceeds 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.

Change indentation of broken synopsis lines from 10n or 2n to 6n for
consistency with other recently edited ncurses man pages.
---
 man/curs_border.3x     | 12 ++++----
 man/curs_border_set.3x | 65 +++++++++++++++++-------------------------
 2 files changed, 32 insertions(+), 45 deletions(-)

diff --git a/man/curs_border.3x b/man/curs_border.3x
index 172168027..3732d7c6f 100644
--- a/man/curs_border.3x
+++ b/man/curs_border.3x
@@ -57,20 +57,20 @@ .SH SYNOPSIS
 \fB#include <curses.h>
 .PP
 \fBint border(chtype \fIls\fP, chtype \fIrs\fP, chtype \fIts\fP, chtype 
\fIbs\fP,
-           \fBchtype \fItl\fB, chtype \fItr\fB, chtype \fIbl\fB, chtype 
\fIbr\fB);\fR
+      \fBchtype \fItl\fB, chtype \fItr\fB, chtype \fIbl\fB, chtype 
\fIbr\fB);\fR
 \fBint wborder(WINDOW *\fIwin\fB, chtype \fIls\fB, chtype \fIrs\fB,\fR
-            \fBchtype \fIts\fB, chtype \fIbs\fB, chtype \fItl\fB, chtype 
\fItr\fB,\fR
-            \fBchtype \fIbl\fB, chtype \fIbr\fB);\fR
+      \fBchtype \fIts\fB, chtype \fIbs\fB, chtype \fItl\fB, chtype \fItr\fB,\fR
+      \fBchtype \fIbl\fB, chtype \fIbr\fB);\fR
 .PP
 \fBint box(WINDOW *\fIwin\fB, chtype \fIverch\fB, chtype \fIhorch\fB);\fR
 .PP
 \fBint hline(chtype \fIch\fB, int \fIn\fB);\fR
 \fBint whline(WINDOW *\fIwin\fB, chtype \fIch\fB, int \fIn\fB);\fR
-\fBint vline(chtype \fIch\fB, int \fIn\fB);\fR
-\fBint wvline(WINDOW *\fIwin\fB, chtype \fIch\fB, int \fIn\fB);\fR
-.PP
 \fBint mvhline(int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR
 \fBint mvwhline(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB, 
int \fIn\fB);\fR
+.PP
+\fBint vline(chtype \fIch\fB, int \fIn\fB);\fR
+\fBint wvline(WINDOW *\fIwin\fB, chtype \fIch\fB, int \fIn\fB);\fR
 \fBint mvvline(int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR
 \fBint mvwvline(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB, 
int \fIn\fB);\fR
 .fi
diff --git a/man/curs_border_set.3x b/man/curs_border_set.3x
index d1b2c6e6a..5cb83d4ef 100644
--- a/man/curs_border_set.3x
+++ b/man/curs_border_set.3x
@@ -56,46 +56,33 @@ .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
-\fBint border_set(
-   \fBconst cchar_t *\fIls\fB, const cchar_t *\fIrs\fP,
-   \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP,
-   \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP,
-   \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR
+\fBint border_set(const cchar_t *\fIls\fB, const cchar_t *\fIrs\fP,
+      \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP,
+      \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP,
+      \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR
 .br
-\fBint wborder_set(\fP
-   \fBWINDOW *\fIwin\fP,
-   \fBconst cchar_t *\fIls\fB, const cchar_t *\fIrs\fP,
-   \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP,
-   \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP,
-   \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR
-\fBint box_set(\fP
-   \fBWINDOW *\fIwin\fP,
-   \fBconst cchar_t *\fIverch\fP,
-   \fBconst cchar_t *\fIhorch\fB);\fR
-\fBint hline_set(\fP
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
-\fBint whline_set(\fP
-   \fBWINDOW *\fIwin\fP,
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
-\fBint mvhline_set(\fP
-   \fBint \fIy\fB, int \fIx\fP,
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
-\fBint mvwhline_set(\fP
-   \fBWINDOW *\fIwin\fP,
-   \fBint \fIy\fB, int \fIx\fP,
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
-\fBint vline_set(\fP
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
-\fBint wvline_set(\fP
-   \fBWINDOW *\fIwin\fP,
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
-\fBint mvvline_set(\fP
-   \fBint \fIy\fB, int \fIx\fP,
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
-\fBint mvwvline_set(\fP
-   \fBWINDOW *\fIwin\fP,
-   \fBint \fIy\fB, int \fIx\fP,
-   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
+\fBint wborder_set(\fBWINDOW *\fIwin\fP,
+      \fBconst cchar_t *\fIls\fB, const cchar_t *\fIrs\fP,
+      \fBconst cchar_t *\fIts\fB, const cchar_t *\fIbs\fP,
+      \fBconst cchar_t *\fItl\fB, const cchar_t *\fItr\fP,
+      \fBconst cchar_t *\fIbl\fB, const cchar_t *\fIbr\fB);\fR
+.PP
+\fBint box_set(\fBWINDOW *\fIwin\fP, \fBconst cchar_t *\fIverch\fP,
+      \fBconst cchar_t *\fIhorch\fB);\fR
+.PP
+\fBint hline_set(const cchar_t *\fIwch\fB, int \fIn\fB);\fR
+\fBint whline_set(WINDOW *\fIwin\fP, \fBconst cchar_t *\fIwch\fB, int 
\fIn\fB);\fR
+\fBint mvhline_set(int \fIy\fB, int \fIx\fP, \fBconst cchar_t *\fIwch\fB,
+      int \fIn\fB);\fR
+\fBint mvwhline_set(WINDOW *\fIwin\fP, \fBint \fIy\fB, int \fIx\fP,
+      \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
+.PP
+\fBint vline_set(const cchar_t *\fIwch\fB, int \fIn\fB);\fR
+\fBint wvline_set(WINDOW *\fIwin\fP, \fBconst cchar_t *\fIwch\fB, int 
\fIn\fB);\fR
+\fBint mvvline_set(int \fIy\fB, int \fIx\fP, \fBconst cchar_t *\fIwch\fB,
+      int \fIn\fB);\fR
+\fBint mvwvline_set(WINDOW *\fIwin\fP, \fBint \fIy\fB, int \fIx\fP,
+      \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
 .fi
 .SH DESCRIPTION
 The
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

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