ncurses 6.5 - patch 20240519

[ncurses.git] / man / curs_border_set.3x

diff --git a/man/curs_border_set.3x b/man/curs_border_set.3x
index 5b672f7de6b8d582b7bc57c23a99d01c3986355b..3077da6b49f7d7885a255bcef7c471f86ffaafdb 100644 (file)
--- a/man/curs_border_set.3x
+++ b/man/curs_border_set.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
-.\" Copyright 2019-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2019-2023,2024 Thomas E. Dickey                                *
 .\" Copyright 2002-2011,2012 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
@@ -27,12 +27,18 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: curs_border_set.3x,v 1.24 2023/09/16 23:34:43 tom Exp $
-.TH curs_border_set 3X 2023-09-16 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_border_set.3x,v 1.36 2024/04/20 21:20:07 tom Exp $
+.TH curs_border_set 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
 .SH NAME
 \fB\%border_set\fP,
 \fB\%wborder_set\fP,
@@ -47,58 +53,50 @@
 \fB\%mvwvline_set\fP \-
 draw borders and lines in a \fIcurses\fR window of wide characters
 .SH SYNOPSIS
-\fB#include <curses.h>\fP
-.sp
-\fBint border_set(\fP
-   \fBconst cchar_t *\fIls\fR, \fBconst cchar_t *\fIrs\fR,
-   \fBconst cchar_t *\fIts\fR, \fBconst cchar_t *\fIbs\fR,
-   \fBconst cchar_t *\fItl\fR, \fBconst cchar_t *\fItr\fR,
-   \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fR
-\fB);\fP
+.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
 .br
 \fBint wborder_set(\fP
-   \fBWINDOW *win\fP,
-   \fBconst cchar_t *\fIls\fR, \fBconst cchar_t *\fIrs\fR,
-   \fBconst cchar_t *\fIts\fR, \fBconst cchar_t *\fIbs\fR,
-   \fBconst cchar_t *\fItl\fR, \fBconst cchar_t *\fItr\fR,
-   \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fB);\fR
-.br
+   \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 *win\fP,
-   \fBconst cchar_t *\fIverch\fR,
+   \fBWINDOW *\fIwin\fP,
+   \fBconst cchar_t *\fIverch\fP,
    \fBconst cchar_t *\fIhorch\fB);\fR
-.br
 \fBint hline_set(\fP
-   \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
 \fBint whline_set(\fP
-   \fBWINDOW *\fIwin\fR,
-   \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+   \fBWINDOW *\fIwin\fP,
+   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
 \fBint mvhline_set(\fP
-   \fBint \fIy\fR, \fBint \fIx\fR,
-   \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+   \fBint \fIy\fB, int \fIx\fP,
+   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
 \fBint mvwhline_set(\fP
-   \fBWINDOW *\fIwin\fR,
-   \fBint \fIy\fR, \fBint \fIx\fR,
-   \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+   \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\fR, \fBint \fIn\fB);\fR
-.br
+   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
 \fBint wvline_set(\fP
-   \fBWINDOW *\fIwin\fR,
-   \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+   \fBWINDOW *\fIwin\fP,
+   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
 \fBint mvvline_set(\fP
-   \fBint \fIy\fR, \fBint \fIx\fR,
-   \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
-.br
+   \fBint \fIy\fB, int \fIx\fP,
+   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
 \fBint mvwvline_set(\fP
-   \fBWINDOW *\fIwin\fR,
-   \fBint \fIy\fR, \fBint \fIx\fR,
-   \fBconst cchar_t *\fIwch\fR, \fBint \fIn\fB);\fR
+   \fBWINDOW *\fIwin\fP,
+   \fBint \fIy\fB, int \fIx\fP,
+   \fBconst cchar_t *\fIwch\fB, int \fIn\fB);\fR
+.fi
 .SH DESCRIPTION
 The
 \fBborder_set\fP
@@ -173,7 +171,19 @@ The
 \fBmvwvline_set\fP, and
 \fBwvline_set\fP
 functions draw a line proceeding toward the last line of the window.
-.br
+.SH RETURN VALUE
+Upon successful completion, these functions return
+\fBOK\fP.
+Otherwise, they return
+\fBERR\fP.
+.PP
+Functions using a window parameter return an error if it is null.
+.PP
+Functions prefixed with \*(``mv\*('' first perform cursor movement and
+fail if the position
+.RI ( y ,
+.IR x )
+is outside the window boundaries.
 .SH NOTES
 Note that
 \fBborder_set\fP,
@@ -184,19 +194,10 @@ Note that
 \fBmvwvline_set\fP, and
 \fBvline_set\fP
 may be macros.
-.SH RETURN VALUE
-Upon successful completion, these functions return
-\fBOK\fP.
-Otherwise, they return
-\fBERR\fP.
-.PP
-Functions using a window parameter return an error if it is null.
-.PP
-Functions with a \*(``mv\*('' prefix first perform a cursor movement using
-\fBwmove\fP, and return an error if the position is outside the window,
-or if the window pointer is null.
+.SH PORTABILITY
+These functions are described in X/Open Curses, Issue 4.
 .SH SEE ALSO
-\fBncurses\fP(3X),
-\fBcurs_add_wch\fP(3X),
-\fBcurs_border\fP(3X),
-\fBcurs_outopts\fP(3X)
+\fB\%curses\fP(3X),
+\fB\%curs_add_wch\fP(3X),
+\fB\%curs_border\fP(3X),
+\fB\%curs_outopts\fP(3X)