ncurses 6.3 - patch 20220402

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

diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index 87d6b5c5c6546798c402bc464760133b3ae77fd3..6820ce0c1357caca5fe22196e4c05677ce981fc4 100644 (file)
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2017,2019 Free Software Foundation, Inc.              *
+.\" Copyright 2019-2021,2022 Thomas E. Dickey                                *
+.\" Copyright 1998-2012,2017 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,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_addstr.3x,v 1.19 2019/11/30 21:06:30 tom Exp $
+.\" $Id: curs_addstr.3x,v 1.26 2022/02/12 20:07:29 tom Exp $

 .TH curs_addstr 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``
 .TH curs_addstr 3X ""
 .ie \n(.g .ds `` \(lq
 .el       .ds `` ``


@@ -39,51 +40,51 @@
 .na
 .hy 0
 .SH NAME
 .na
 .hy 0
 .SH NAME

-\fBaddstr\fR,
-\fBaddnstr\fR,
-\fBwaddstr\fR,
-\fBwaddnstr\fR,
-\fBmvaddstr\fR,
-\fBmvaddnstr\fR,
-\fBmvwaddstr\fR,
-\fBmvwaddnstr\fR \- add a string of characters to a \fBcurses\fR window and advance cursor
+\fBaddstr\fP,
+\fBaddnstr\fP,
+\fBwaddstr\fP,
+\fBwaddnstr\fP,
+\fBmvaddstr\fP,
+\fBmvaddnstr\fP,
+\fBmvwaddstr\fP,
+\fBmvwaddnstr\fP \- add a string of characters to a \fBcurses\fP window and advance cursor

 .ad
 .hy
 .SH SYNOPSIS
 .nf
 .ad
 .hy
 .SH SYNOPSIS
 .nf

-\fB#include <curses.h>\fR
+\fB#include <curses.h>\fP

 .PP
 .PP

-\fBint addstr(const char *\fR\fIstr\fR\fB);\fR
+\fBint addstr(const char *\fIstr\fB);\fR

 .br
 .br

-\fBint addnstr(const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
+\fBint addnstr(const char *\fIstr\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint waddstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB);\fR
+\fBint waddstr(WINDOW *\fIwin\fB, const char *\fIstr\fB);\fR

 .br
 .br

-\fBint waddnstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
+\fBint waddnstr(WINDOW *\fIwin\fB, const char *\fIstr\fB, int \fIn\fB);\fR
+.sp
+\fBint mvaddstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR

 .br
 .br

-\fBint mvaddstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR
+\fBint mvaddnstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint mvaddnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR
+\fBint mvwaddstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR

 .br
 .br

-\fBint mvwaddstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR
-.br
-\fBint mvwaddnstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr, int \fR\fIn\fR\fB);\fR
+\fBint mvwaddnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr, int \fIn\fB);\fR

 .fi
 .SH DESCRIPTION
 These functions write the (null-terminated) character string
 .fi
 .SH DESCRIPTION
 These functions write the (null-terminated) character string

-\fIstr\fR on the given window.
-It is similar to calling \fBwaddch\fR once for each character in the string.
+\fIstr\fP on the given window.
+It is similar to calling \fBwaddch\fP once for each byte in the string.

 .PP
 .PP

-The \fImv\fR functions perform cursor movement once, before writing any
+The \fImv\fP functions perform cursor movement once, before writing any

 characters.
 Thereafter, the cursor is advanced as a side-effect of writing to the window.
 .PP
 characters.
 Thereafter, the cursor is advanced as a side-effect of writing to the window.
 .PP

-The four functions with \fIn\fR as the last argument
-write at most \fIn\fR characters,
+The four functions with \fIn\fP as the last argument
+write at most \fIn\fP bytes,

 or until a terminating null is reached.
 or until a terminating null is reached.

-If \fIn\fR is \-1, then the entire string will be added.
+If \fIn\fP is \-1, then the entire string will be added.

 .SH RETURN VALUE
 .SH RETURN VALUE

-All functions return the integer \fBERR\fR upon failure and \fBOK\fR on success.
+All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.

 .PP
 X/Open does not define any error conditions.
 This implementation returns an error
 .PP
 X/Open does not define any error conditions.
 This implementation returns an error


@@ -97,10 +98,22 @@ if the corresponding calls to \fBwaddch\fP return an error.
 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.
 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.

+If an error is returned by the \fBwmove\fP,
+no characters are added to the window.
+.PP
+If an error is returned by \fBwaddch\fP
+(e.g.,
+because the window is not large enough,
+or an illegal byte sequence was detected)
+only part of the string may be added.
+Aside from that,
+there is a special case in \fBwaddch\fP where an error may be
+returned after successfully writing a character to the lower-right corner
+of a window when \fBscrollok\fP is disabled.

 .SH NOTES
 .SH NOTES

-All of these functions except \fBwaddnstr\fR may be macros.
+All of these functions except \fBwaddnstr\fP may be macros.

 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO
 .SH PORTABILITY
 These functions are described in the XSI Curses standard, Issue 4.
 .SH SEE ALSO

-\fBcurses\fR(3X),
-\fBcurs_addch\fR(3X).
+\fBcurses\fP(3X),
+\fBcurs_addch\fP(3X).