X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_border.3x;fp=man%2Fcurs_border.3x;h=588174a4d4e2f428386df91a6ecce93ab1e69307;hp=7b41da530445400f18aa480b01eeaf5757be37d5;hb=74433bcf4f6fe40862a28f3c00edaedcd5054b01;hpb=e6bb3226cdd35f5fd9f45bb1685cc2203c889480 diff --git a/man/curs_border.3x b/man/curs_border.3x index 7b41da53..588174a4 100644 --- a/man/curs_border.3x +++ b/man/curs_border.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2020,2021 Thomas E. Dickey * .\" Copyright 1998-2007,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,7 +27,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_border.3x,v 1.27 2020/10/18 00:33:06 tom Exp $ +.\" $Id: curs_border.3x,v 1.29 2021/12/25 21:49:32 tom Exp $ .TH curs_border 3X "" .ie \n(.g .ds `` \(lq .el .ds `` `` @@ -36,112 +36,112 @@ .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\fP, +\fBwborder\fP, +\fBbox\fP, +\fBhline\fP, +\fBwhline\fP, +\fBvline\fP, +\fBwvline\fP, +\fBmvhline\fP, +\fBmvwhline\fP, +\fBmvvline\fP, +\fBmvwvline\fP \- create \fBcurses\fP borders, horizontal and vertical lines .ad .hy .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .sp -\fBint border(chtype \fP\fIls\fP\fB, chtype \fP\fIrs\fP\fB, chtype \fP\fIts\fP\fB, chtype \fP\fIbs\fP\fB,\fR - \fBchtype \fP\fItl\fP\fB, chtype \fP\fItr\fP\fB, chtype \fP\fIbl\fP\fB, chtype \fP\fIbr\fP\fB);\fR +\fBint border(chtype \fP\fIls\fP\fB, chtype \fP\fIrs\fP\fB, chtype \fP\fIts\fP\fB, chtype \fP\fIbs\fP\fB,\fP + \fBchtype \fP\fItl\fP\fB, chtype \fP\fItr\fP\fB, chtype \fP\fIbl\fP\fB, chtype \fP\fIbr\fP\fB);\fP .br -\fBint wborder(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIls\fP\fB, chtype \fP\fIrs\fP\fB,\fR - \fBchtype \fP\fIts\fP\fB, chtype \fP\fIbs\fP\fB, chtype \fP\fItl\fP\fB, chtype \fP\fItr\fP\fB,\fR - \fBchtype \fP\fIbl\fP\fB, chtype \fP\fIbr\fP\fB);\fR +\fBint wborder(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIls\fP\fB, chtype \fP\fIrs\fP\fB,\fP + \fBchtype \fP\fIts\fP\fB, chtype \fP\fIbs\fP\fB, chtype \fP\fItl\fP\fB, chtype \fP\fItr\fP\fB,\fP + \fBchtype \fP\fIbl\fP\fB, chtype \fP\fIbr\fP\fB);\fP .sp -\fBint box(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIverch\fP\fB, chtype \fP\fIhorch\fP\fB);\fR +\fBint box(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIverch\fP\fB, chtype \fP\fIhorch\fP\fB);\fP .sp -\fBint hline(chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint hline(chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .br -\fBint whline(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint whline(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .br -\fBint vline(chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint vline(chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .br -\fBint wvline(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint wvline(WINDOW *\fP\fIwin\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .sp -\fBint mvhline(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint mvhline(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .br -\fBint mvwhline(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint mvwhline(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .br -\fBint mvvline(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint mvvline(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .br -\fBint mvwvline(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint mvwvline(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, chtype \fP\fIch\fP\fB, int \fP\fIn\fP\fB);\fP .br .SH DESCRIPTION -The \fBborder\fR, \fBwborder\fR and \fBbox\fR routines +The \fBborder\fP, \fBwborder\fP and \fBbox\fP 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, +\fIls\fP \- left side, .br -\fIrs\fR \- right side, +\fIrs\fP \- right side, .br -\fIts\fR \- top side, +\fIts\fP \- top side, .br -\fIbs\fR \- bottom side, +\fIbs\fP \- bottom side, .br -\fItl\fR \- top left-hand corner, +\fItl\fP \- top left-hand corner, .br -\fItr\fR \- top right-hand corner, +\fItr\fP \- top right-hand corner, .br -\fIbl\fR \- bottom left-hand corner, and +\fIbl\fP \- bottom left-hand corner, and .br -\fIbr\fR \- bottom right-hand corner. +\fIbr\fP \- 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: +default values (defined in \fBcurses.h\fP) are used instead: .sp .RS -\fBACS_VLINE\fR, +\fBACS_VLINE\fP, .br -\fBACS_VLINE\fR, +\fBACS_VLINE\fP, .br -\fBACS_HLINE\fR, +\fBACS_HLINE\fP, .br -\fBACS_HLINE\fR, +\fBACS_HLINE\fP, .br -\fBACS_ULCORNER\fR, +\fBACS_ULCORNER\fP, .br -\fBACS_URCORNER\fR, +\fBACS_URCORNER\fP, .br -\fBACS_LLCORNER\fR, +\fBACS_LLCORNER\fP, .br -\fBACS_LRCORNER\fR. +\fBACS_LRCORNER\fP. .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(\fP\fIwin\fP\fB, \fP\fIverch\fP\fB, \fP\fIhorch\fP\fB)\fP is a shorthand +for the following call: \fBwborder(\fP\fIwin\fP\fB,\fP \fIverch\fP\fB,\fP +\fIverch\fP\fB,\fP \fIhorch\fP\fB,\fP \fIhorch\fP\fB, 0, 0, 0, 0)\fP. .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 \fBhline\fP and \fBwhline\fP functions draw a horizontal (left to right) +line using \fIch\fP starting at the current cursor position in the window. The current cursor position is not changed. -The line is at most \fIn\fR characters +The line is at most \fIn\fP 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 \fBvline\fP and \fBwvline\fP functions draw a vertical (top to bottom) line +using \fIch\fP starting at the current cursor position in the window. The current cursor position is not changed. -The line is at most \fIn\fR characters +The line is at most \fIn\fP characters long, or as many as fit into the window. .SH RETURN VALUE -All routines return the integer \fBOK\fR. +All routines return the integer \fBOK\fP. The SVr4.0 manual says "or a -non-negative integer if \fBimmedok\fR is set", but this appears to be an error. +non-negative integer if \fBimmedok\fP is set", but this appears to be an error. .PP X/Open does not define any error conditions. This implementation returns an error @@ -151,13 +151,13 @@ 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 +The borders generated by these functions are \fIinside\fP 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. +Note that \fBborder\fP and \fBbox\fP may be macros. .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. -The standard specifies that they return \fBERR\fR on failure, +The standard specifies that they return \fBERR\fP on failure, but specifies no error conditions. .SH SEE ALSO -\fBcurses\fR(3X), \fBcurs_outopts\fR(3X). +\fBcurses\fP(3X), \fBcurs_outopts\fP(3X).