X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_border.3x;h=bbd9d8f325b061be229ceb2dbe22ec13c61dd42a;hb=02f1dee48fe8af6ce054388fba739aa4f975004e;hp=09f9a4c221f91f3f40e73c13732bd6e4027c42f6;hpb=b6d7123594f6959ad0a6602b3952d9e6abe261a0;p=ncurses.git diff --git a/man/curs_border.3x b/man/curs_border.3x index 09f9a4c2..bbd9d8f3 100644 --- a/man/curs_border.3x +++ b/man/curs_border.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2018,2019 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 * @@ -26,8 +26,12 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border.3x,v 1.19 2007/02/24 16:15:38 tom Exp $ +.\" $Id: curs_border.3x,v 1.24 2019/11/30 21:06:30 tom Exp $ .TH curs_border 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .na .hy 0 .SH NAME @@ -41,7 +45,7 @@ \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 @@ -78,21 +82,21 @@ draw a box around the edges of a window. Other than the window, each argument is a character with attributes: .sp .RS -\fIls\fR - left side, +\fIls\fR \- left side, .br -\fIrs\fR - right side, +\fIrs\fR \- right side, .br -\fIts\fR - top side, +\fIts\fR \- top side, .br -\fIbs\fR - bottom side, +\fIbs\fR \- bottom side, .br -\fItl\fR - top left-hand corner, +\fItl\fR \- top left-hand corner, .br -\fItr\fR - top right-hand corner, +\fItr\fR \- top right-hand corner, .br -\fIbl\fR - bottom left-hand corner, and +\fIbl\fR \- bottom left-hand corner, and .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 @@ -121,21 +125,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) -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 -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 -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. +.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). @@ -147,9 +160,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). -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: