ncurses 5.7 - patch 20100911

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

diff --git a/man/curs_border.3x b/man/curs_border.3x
index 3071d2a603ea3af3b50ac3b23a0bc4d53718f44e..09c2f5cf1a392699775043cbf58903f41008c51a 100644 (file)
--- a/man/curs_border.3x
+++ b/man/curs_border.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

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

-.\" $Id: curs_border.3x,v 1.18 2006/02/25 21:49:19 tom Exp $
+.\" $Id: curs_border.3x,v 1.21 2010/08/14 23:29:16 tom Exp $

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


@@ -41,7 +41,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 +64,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


@@ -78,21 +78,21 @@ draw a box around the edges of a window.
 Other than the window, each argument is a character with attributes:
 .sp
 .RS
 Other than the window, each argument is a character with attributes:
 .sp
 .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
 .PP
 If any of these arguments is zero, then the corresponding
 .RE
 .PP
 If any of these arguments is zero, then the corresponding


@@ -136,6 +136,10 @@ non-negative integer if \fBimmedok\fR is set", but this appears to be an error.
 X/Open does not define any error conditions.
 This implementation returns an error
 if the window pointer is null.
 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).