X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_border.3x;h=3071d2a603ea3af3b50ac3b23a0bc4d53718f44e;hp=c087fad73bcd97cfb64b03b014de2fde81c95a92;hb=0c9774ef662e2137933ac0c79077eaa9c8981357;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/curs_border.3x b/man/curs_border.3x index c087fad7..3071d2a6 100644 --- a/man/curs_border.3x +++ b/man/curs_border.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright (c) 1998,2000 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2005,2006 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,14 +26,24 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border.3x,v 1.15 2002/02/16 22:21:47 tom Exp $ +.\" $Id: curs_border.3x,v 1.18 2006/02/25 21:49:19 tom Exp $ .TH curs_border 3X "" +.na +.hy 0 .SH NAME -\fBborder\fR, \fBwborder\fR, \fBbox\fR, -\fBhline\fR, \fBwhline\fR, -\fBvline\fR, \fBwvline\fR, -\fBmvhline\fR, \fBmvwhline\fR, -\fBmvvline\fR, \fBmvwvline\fR - create \fBcurses\fR borders, horizontal and vertical lines +\fBborder\fR, +\fBwborder\fR, +\fBbox\fR, +\fBhline\fR, +\fBwhline\fR, +\fBvline\fR, +\fBwvline\fR, +\fBmvhline\fR, +\fBmvwhline\fR, +\fBmvvline\fR, +\fBmvwvline\fR - create \fBcurses\fR borders, horizontal and vertical lines +.ad +.hy .SH SYNOPSIS \fB#include \fR .br @@ -66,6 +76,7 @@ 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 \fIls\fR - left side, .br @@ -83,8 +94,10 @@ Other than the window, each argument is a character with attributes: .br \fIbr\fR - bottom right-hand corner. .RE +.PP 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 @@ -102,16 +115,16 @@ default values (defined in \fBcurses.h\fR) are used instead: .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. - +.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 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 @@ -119,10 +132,14 @@ 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 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. .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.