ncurses 6.1 - patch 20190406

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

diff --git a/man/curs_border.3x b/man/curs_border.3x
index 16b98c3d018880eb12849ab21f1eaacc4f2529a5..70efe1ec587c7144e8d47f0857bfa4165f08a6ed 100644 (file)
--- a/man/curs_border.3x
+++ b/man/curs_border.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2010,2018 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,7 +26,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_border.3x,v 1.20 2010/07/31 16:12:01 tom Exp $
+.\" $Id: curs_border.3x,v 1.23 2018/07/28 21:34:06 tom Exp $

 .TH curs_border 3X ""
 .na
 .hy 0
 .TH curs_border 3X ""
 .na
 .hy 0


@@ -121,21 +121,30 @@ 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)
 \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)

-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.
 .PP
 The \fBvline\fR and \fBwvline\fR functions draw a vertical (top to bottom) line
 long, or as many as fit into the window.
 .PP
 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).


@@ -147,9 +156,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: