ncurses 6.1 - patch 20190727

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

diff --git a/man/curs_printw.3x b/man/curs_printw.3x
index 9918f9df9a718918cc62edd9a56c6b09dc53cb66..a0b95bbc9e6b195f8809ad1243f1dd3147113908 100644 (file)
--- a/man/curs_printw.3x
+++ b/man/curs_printw.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

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

-.\" $Id: curs_printw.3x,v 1.20 2010/12/04 18:40:45 tom Exp $
+.\" $Id: curs_printw.3x,v 1.23 2018/07/28 21:14:06 tom Exp $

 .TH curs_printw 3X ""
 .TH curs_printw 3X ""

+.de bP
+.ie n  .IP \(bu 4
+.el    .IP \(bu 2
+..

 .na
 .hy 0
 .SH NAME
 .na
 .hy 0
 .SH NAME


@@ -49,13 +53,15 @@
 .br
 \fBint mvwprintw(WINDOW *win, int y, int x, const char *fmt, ...);\fR
 .br
 .br
 \fBint mvwprintw(WINDOW *win, int y, int x, const char *fmt, ...);\fR
 .br

-\fBint vwprintw(WINDOW *win, const char *fmt, va_list varglist);\fR
-.br

 \fBint vw_printw(WINDOW *win, const char *fmt, va_list varglist);\fR
 \fBint vw_printw(WINDOW *win, const char *fmt, va_list varglist);\fR

+.sp
+/* obsolete */

 .br
 .br

+\fBint vwprintw(WINDOW *win, const char *fmt, va_list varglist);\fR

 .SH DESCRIPTION
 The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR
 .SH DESCRIPTION
 The \fBprintw\fR, \fBwprintw\fR, \fBmvprintw\fR and \fBmvwprintw\fR

-routines are analogous to \fBprintf\fR [see \fBprintf\fR(3)].  In
+routines are analogous to \fBprintf\fR [see \fBprintf\fR(3)].
+In

 effect, the string that would be output by \fBprintf\fR is output
 instead as though \fBwaddstr\fR were used on the given window.
 .PP
 effect, the string that would be output by \fBprintf\fR is output
 instead as though \fBwaddstr\fR were used on the given window.
 .PP


@@ -79,14 +85,29 @@ 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 PORTABILITY
 \fBwmove\fP, and return an error if the position is outside the window,
 or if the window pointer is null.
 .SH PORTABILITY

-The XSI Curses standard, Issue 4 describes these functions.  The function
+In this implementation, \fBvw_printw\fP and \fBvwprintw\fP are equivalent,
+to support legacy applications.
+However, the latter (\fBvwprintw\fP) is obsolete:
+.bP
+The XSI Curses standard, Issue 4 described these functions.
+The function

 \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
 \fBvw_printw\fR using the \fB<stdarg.h>\fR interface.
 \fBvwprintw\fR is marked TO BE WITHDRAWN, and is to be replaced by a function
 \fBvw_printw\fR using the \fB<stdarg.h>\fR interface.

+.bP

 The Single Unix Specification, Version 2 states that
 \fBvw_printw\fR  is preferred to \fBvwprintw\fR since the latter requires
 including \fB<varargs.h>\fR, which
 cannot be used in the same file as \fB<stdarg.h>\fR.
 The Single Unix Specification, Version 2 states that
 \fBvw_printw\fR  is preferred to \fBvwprintw\fR since the latter requires
 including \fB<varargs.h>\fR, which
 cannot be used in the same file as \fB<stdarg.h>\fR.

-This implementation uses \fB<stdarg.h>\fR for both, because that header
-is included in \fB<curses.h\fR>.
+This implementation uses \fB<stdarg.h>\fR for both,
+because that header is included in \fB<curses.h\fR>.
+.bP
+X/Open Curses, Issue 5 (December 2007) marked \fBvwprintw\fP (along with
+\fBvwscanw\fP and the termcap interface) as withdrawn.

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBprintf\fR(3), \fBvprintf(3)\fR
+.na
+\fBcurses\fR(3X),
+\fBcurs_addstr\fR(3X),
+\fBcurs_scanw\fR(3X),
+\fBcurs_termcap\fP(3X),
+\fBprintf\fR(3),
+\fBvprintf\fR(3).