ncurses 6.2 - patch 20200212

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

diff --git a/man/curs_border.3x b/man/curs_border.3x
index 2b18d8b0a0b56a1c04fd0d54a36c230dcbaaa110..eaf6954878eaafbe49d1c87bf8f7cc61a50a3455 100644 (file)
--- a/man/curs_border.3x
+++ b/man/curs_border.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2002,2005 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
+.\" Copyright 1998-2007,2010 Free Software Foundation, Inc.                  *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -26,8 +27,12 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_border.3x,v 1.17 2005/05/15 16:17:31 tom Exp $
+.\" $Id: curs_border.3x,v 1.25 2020/02/02 23:34:34 tom Exp $

 .TH curs_border 3X ""
 .TH curs_border 3X ""

+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''

 .na
 .hy 0
 .SH NAME
 .na
 .hy 0
 .SH NAME


@@ -41,7 +46,7 @@
 \fBmvhline\fR,
 \fBmvwhline\fR,
 \fBmvvline\fR,
 \fBmvhline\fR,
 \fBmvwhline\fR,
 \fBmvvline\fR,

-\fBmvwvline\fR - create \fBcurses\fR borders, horizontal and vertical lines
+\fBmvwvline\fR \- create \fBcurses\fR borders, horizontal and vertical lines

 .ad
 .hy
 .SH SYNOPSIS
 .ad
 .hy
 .SH SYNOPSIS


@@ -64,9 +69,9 @@
 .br
 \fBint wvline(WINDOW *win, chtype ch, int n);\fR
 .br
 .br
 \fBint wvline(WINDOW *win, chtype ch, int n);\fR
 .br

-\fBmvhline(int y, int x, chtype ch, int n);\fR
+\fBint mvhline(int y, int x, chtype ch, int n);\fR

 .br
 .br

-\fBmvwhline(WINDOW *, int y, int x, chtype ch, int n);\fR
+\fBint mvwhline(WINDOW *, int y, int x, chtype ch, int n);\fR

 .br
 \fBint mvvline(int y, int x, chtype ch, int n);\fR
 .br
 .br
 \fBint mvvline(int y, int x, chtype ch, int n);\fR
 .br


@@ -76,25 +81,28 @@
 The \fBborder\fR, \fBwborder\fR and \fBbox\fR routines
 draw a box around the edges of a window.
 Other than the window, each argument is a character with attributes:
 The \fBborder\fR, \fBwborder\fR and \fBbox\fR routines
 draw a box around the edges of a window.
 Other than the window, each argument is a character with attributes:

+.sp

 .RS
 .RS

-\fIls\fR - left side,
+\fIls\fR \- left side,

 .br
 .br

-\fIrs\fR - right side,
+\fIrs\fR \- right side,

 .br
 .br

-\fIts\fR - top side,
+\fIts\fR \- top side,

 .br
 .br

-\fIbs\fR - bottom side,
+\fIbs\fR \- bottom side,

 .br
 .br

-\fItl\fR - top left-hand corner,
+\fItl\fR \- top left-hand corner,

 .br
 .br

-\fItr\fR - top right-hand corner,
+\fItr\fR \- top right-hand corner,

 .br
 .br

-\fIbl\fR - bottom left-hand corner, and
+\fIbl\fR \- bottom left-hand corner, and

 .br
 .br

-\fIbr\fR - bottom right-hand corner.
+\fIbr\fR \- bottom right-hand corner.

 .RE
 .RE

+.PP

 If any of these arguments is zero, then the corresponding
 default values (defined in \fBcurses.h\fR) are used instead:
 If any of these arguments is zero, then the corresponding
 default values (defined in \fBcurses.h\fR) are used instead:

+.sp

 .RS
 \fBACS_VLINE\fR,
 .br
 .RS
 \fBACS_VLINE\fR,
 .br


@@ -112,31 +120,40 @@ default values (defined in \fBcurses.h\fR) are used instead:
 .br
 \fBACS_LRCORNER\fR.
 .RE
 .br
 \fBACS_LRCORNER\fR.
 .RE

-
+.PP

 \fBbox(\fR\fIwin\fR\fB, \fR\fIverch\fR\fB, \fR\fIhorch\fR\fB)\fR is a shorthand
 for the following call: \fBwborder(\fR\fIwin\fR\fB,\fR \fIverch\fR\fB,\fR
 \fIverch\fR\fB,\fR \fIhorch\fR\fB,\fR \fIhorch\fR\fB, 0, 0, 0, 0)\fR.
 \fBbox(\fR\fIwin\fR\fB, \fR\fIverch\fR\fB, \fR\fIhorch\fR\fB)\fR is a shorthand
 for the following call: \fBwborder(\fR\fIwin\fR\fB,\fR \fIverch\fR\fB,\fR
 \fIverch\fR\fB,\fR \fIhorch\fR\fB,\fR \fIhorch\fR\fB, 0, 0, 0, 0)\fR.

-
+.PP

 The \fBhline\fR and \fBwhline\fR functions draw a horizontal (left to right)
 The \fBhline\fR and \fBwhline\fR functions draw a horizontal (left to right)

-line using \fIch\fR starting at the current cursor position in the window.  The
-current cursor position is not changed.  The line is at most \fIn\fR characters
+line using \fIch\fR starting at the current cursor position in the window.
+The
+current cursor position is not changed.
+The line is at most \fIn\fR characters

 long, or as many as fit into the window.
 long, or as many as fit into the window.

-
+.PP

 The \fBvline\fR and \fBwvline\fR functions draw a vertical (top to bottom) line
 The \fBvline\fR and \fBwvline\fR functions draw a vertical (top to bottom) line

-using \fIch\fR starting at the current cursor position in the window.  The
-current cursor position is not changed.  The line is at most \fIn\fR characters
+using \fIch\fR starting at the current cursor position in the window.
+The
+current cursor position is not changed.
+The line is at most \fIn\fR characters

 long, or as many as fit into the window.
 .SH RETURN VALUE
 long, or as many as fit into the window.
 .SH RETURN VALUE

-All routines return the integer \fBOK\fR.  The SVr4.0 manual says "or a
+All routines return the integer \fBOK\fR.
+The SVr4.0 manual says "or a

 non-negative integer if \fBimmedok\fR is set", but this appears to be an error.
 .PP
 X/Open does not define any error conditions.
 This implementation returns an error
 if the window pointer is null.
 non-negative integer if \fBimmedok\fR is set", but this appears to be an error.
 .PP
 X/Open does not define any error conditions.
 This implementation returns an error
 if the window pointer 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 NOTES
 The borders generated by these functions are \fIinside\fR borders (this
 is also true of SVr4 curses, though the fact is not documented).
 .SH NOTES
 The borders generated by these functions are \fIinside\fR borders (this
 is also true of SVr4 curses, though the fact is not documented).

-
+.PP

 Note that \fBborder\fR and \fBbox\fR may be macros.
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 Note that \fBborder\fR and \fBbox\fR may be macros.
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.


@@ -144,9 +161,3 @@ The standard specifies that they return \fBERR\fR on failure,
 but specifies no error conditions.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_outopts\fR(3X).
 but specifies no error conditions.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBcurs_outopts\fR(3X).

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: