ncurses 6.3 - patch 20220729

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

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

-.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 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,130 +27,137 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_border.3x,v 1.20 2010/07/31 16:12:01 tom Exp $
+.\" $Id: curs_border.3x,v 1.30 2022/02/12 20:06:41 tom Exp $

 .TH curs_border 3X ""
 .TH curs_border 3X ""

+.ie \n(.g .ds `` \(lq
+.el       .ds `` ``
+.ie \n(.g .ds '' \(rq
+.el       .ds '' ''

 .na
 .hy 0
 .SH NAME
 .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
 .ad
 .hy
 .SH SYNOPSIS

-\fB#include <curses.h>\fR
-.br
-\fBint border(chtype ls, chtype rs, chtype ts, chtype bs,\fR
-   \fBchtype tl, chtype tr, chtype bl, chtype br);\fR
-.br
-\fBint wborder(WINDOW *win, chtype ls, chtype rs,\fR
-   \fBchtype ts, chtype bs, chtype tl, chtype tr,\fR
-   \fBchtype bl, chtype br);\fR
-.br
-\fBint box(WINDOW *win, chtype verch, chtype horch);\fR
-.br
-\fBint hline(chtype ch, int n);\fR
+\fB#include <curses.h>\fP
+.sp
+\fBint border(chtype \fIls\fB, chtype \fIrs\fB, chtype \fIts\fB, chtype \fIbs\fB,\fR
+           \fBchtype \fItl\fB, chtype \fItr\fB, chtype \fIbl\fB, chtype \fIbr\fB);\fR

 .br
 .br

-\fBint whline(WINDOW *win, chtype ch, int n);\fR
+\fBint wborder(WINDOW *\fIwin\fB, chtype \fIls\fB, chtype \fIrs\fB,\fR
+            \fBchtype \fIts\fB, chtype \fIbs\fB, chtype \fItl\fB, chtype \fItr\fB,\fR
+            \fBchtype \fIbl\fB, chtype \fIbr\fB);\fR
+.sp
+\fBint box(WINDOW *\fIwin\fB, chtype \fIverch\fB, chtype \fIhorch\fB);\fR
+.sp
+\fBint hline(chtype \fIch\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint vline(chtype ch, int n);\fR
+\fBint whline(WINDOW *\fIwin\fB, chtype \fIch\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint wvline(WINDOW *win, chtype ch, int n);\fR
+\fBint vline(chtype \fIch\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint mvhline(int y, int x, chtype ch, int n);\fR
+\fBint wvline(WINDOW *\fIwin\fB, chtype \fIch\fB, int \fIn\fB);\fR
+.sp
+\fBint mvhline(int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint mvwhline(WINDOW *, int y, int x, chtype ch, int n);\fR
+\fBint mvwhline(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint mvvline(int y, int x, chtype ch, int n);\fR
+\fBint mvvline(int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint mvwvline(WINDOW *, int y, int x, chtype ch, int n);\fR
+\fBint mvwvline(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB, int \fIn\fB);\fR

 .br
 .SH DESCRIPTION
 .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
 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
 .br

-\fIrs\fR \- right side,
+\fIrs\fP \- right side,

 .br
 .br

-\fIts\fR \- top side,
+\fIts\fP \- top side,

 .br
 .br

-\fIbs\fR \- bottom side,
+\fIbs\fP \- bottom side,

 .br
 .br

-\fItl\fR \- top left-hand corner,
+\fItl\fP \- top left-hand corner,

 .br
 .br

-\fItr\fR \- top right-hand corner,
+\fItr\fP \- top right-hand corner,

 .br
 .br

-\fIbl\fR \- bottom left-hand corner, and
+\fIbl\fP \- bottom left-hand corner, and

 .br
 .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
 .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
 .sp
 .RS

-\fBACS_VLINE\fR,
+\fBACS_VLINE\fP,

 .br
 .br

-\fBACS_VLINE\fR,
+\fBACS_VLINE\fP,

 .br
 .br

-\fBACS_HLINE\fR,
+\fBACS_HLINE\fP,

 .br
 .br

-\fBACS_HLINE\fR,
+\fBACS_HLINE\fP,

 .br
 .br

-\fBACS_ULCORNER\fR,
+\fBACS_ULCORNER\fP,

 .br
 .br

-\fBACS_URCORNER\fR,
+\fBACS_URCORNER\fP,

 .br
 .br

-\fBACS_LLCORNER\fR,
+\fBACS_LLCORNER\fP,

 .br
 .br

-\fBACS_LRCORNER\fR.
+\fBACS_LRCORNER\fP.

 .RE
 .PP
 .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(\fIwin\fB, \fIverch\fB, \fIhorch\fB)\fR is a shorthand
+for the following call: \fBwborder(\fIwin\fB,\fR \fIverch\fB,\fR
+\fIverch\fB,\fR \fIhorch\fB,\fR \fIhorch\fB, 0, 0, 0, 0)\fR.

 .PP
 .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
+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\fP characters

 long, or as many as fit into the window.
 .PP
 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
+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\fP 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
-non-negative integer if \fBimmedok\fR is set", but this appears to be an error.
+All routines return the integer \fBOK\fP.
+The SVr4.0 manual says "or a
+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
 if the window pointer is null.
 .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
 .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
 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.
 .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
 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:
+\fBcurses\fP(3X), \fBcurs_outopts\fP(3X).