ncurses 6.4 - patch 20240323

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

diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index fbf46367ab7840bbc8065e8c0f71557d28706788..9286885e3d33e6d0a4d34d64bc3732d35b7cdf35 100644 (file)
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -1,5 +1,5 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright 2019-2022,2023 Thomas E. Dickey                                *
+.\" Copyright 2019-2023,2024 Thomas E. Dickey                                *

 .\" Copyright 1998-2012,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" Copyright 1998-2012,2017 Free Software Foundation, Inc.                  *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *


@@ -27,12 +27,19 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_addchstr.3x,v 1.31 2023/09/16 23:34:43 tom Exp $
-.TH curs_addchstr 3X 2023-09-16 "ncurses 6.4" "Library calls"
-.ie \n(.g .ds `` \(lq
-.el       .ds `` ``
-.ie \n(.g .ds '' \(rq
-.el       .ds '' ''
+.\" $Id: curs_addchstr.3x,v 1.40 2024/03/16 15:37:51 tom Exp $
+.TH curs_addchstr 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
+.ie \n(.g \{\
+.ds `` \(lq
+.ds '' \(rq
+.\}
+.el \{\
+.ie t .ds `` ``
+.el   .ds `` ""
+.ie t .ds '' ''
+.el   .ds '' ""
+.\}
+.

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


@@ -49,29 +56,24 @@
 add a \fIcurses\fR character string to a window
 .SH SYNOPSIS
 .nf
 add a \fIcurses\fR character string to a window
 .SH SYNOPSIS
 .nf

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

 .PP
 .PP

-\fBint addchstr(const chtype *\fIchstr\fB);\fR
-.br
-\fBint addchnstr(const chtype *\fIchstr\fB, int \fIn\fB);\fR
-.br
-\fBint waddchstr(WINDOW *\fIwin\fB, const chtype *\fIchstr\fB);\fR
-.br
-\fBint waddchnstr(WINDOW *\fIwin\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR
-.sp
-\fBint mvaddchstr(int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB);\fR
-.br
-\fBint mvaddchnstr(int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR
-.br
-\fBint mvwaddchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB);\fR
-.br
-\fBint mvwaddchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR
+\fBint addchstr(const chtype *\fIchstr\fP);
+\fBint addchnstr(const chtype *\fIchstr\fP, int \fIn\fP);
+\fBint waddchstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP);
+\fBint waddchnstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP, int \fIn\fP);
+.PP
+\fBint mvaddchstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP);
+\fBint mvaddchnstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP);
+\fBint mvwaddchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP);
+\fBint mvwaddchnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\fP);

 .fi
 .SH DESCRIPTION
 These functions copy the (null-terminated)
 \fIchstr\fP array
 into the window image structure
 starting at the current cursor position.
 .fi
 .SH DESCRIPTION
 These functions copy the (null-terminated)
 \fIchstr\fP array
 into the window image structure
 starting at the current cursor position.

+.PP

 The four functions with \fIn\fP as the last
 argument copy at most \fIn\fP elements,
 but no more than will fit on the line.
 The four functions with \fIn\fP as the last
 argument copy at most \fIn\fP elements,
 but no more than will fit on the line.


@@ -79,7 +81,7 @@ If \fBn\fP=\fB\-1\fP then the whole array is copied,
 to the maximum number of characters that will fit on the line.
 .PP
 The window cursor is \fInot\fP advanced.
 to the maximum number of characters that will fit on the line.
 .PP
 The window cursor is \fInot\fP advanced.

-These functions work faster than \fBwaddnstr\fP.
+These functions are faster than \fBwaddnstr\fP.

 On the other hand:
 .bP
 they do not perform checking
 On the other hand:
 .bP
 they do not perform checking


@@ -94,9 +96,12 @@ rather than wrapping it around to the new line.
 .SH RETURN VALUE
 All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.
 .PP
 .SH RETURN VALUE
 All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success.
 .PP

-X/Open does not define any error conditions.
+X/Open Curses does not specify any error conditions.

 This implementation returns an error
 This implementation returns an error

-if the window pointer is null.
+.bP
+if the \fIwin\fP parameter is null or
+.bP
+if the \fIwchstr\fP parameter 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,
 .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,


@@ -104,11 +109,13 @@ or if the window pointer is null.
 .SH NOTES
 All functions except \fBwaddchnstr\fP may be macros.
 .SH PORTABILITY
 .SH NOTES
 All functions except \fBwaddchnstr\fP may be macros.
 .SH PORTABILITY

-These entry points are described in the XSI Curses standard, Issue 4.
+These functions are described in the XSI Curses standard, Issue 4.

 .SH SEE ALSO
 .SH SEE ALSO

-\fBcurses\fP(3X),
-\fBcurs_addstr\fP(3X).
+\fB\%curses\fP(3X),
+\fB\%curs_addch\fP(3X),
+\fB\%curs_addstr\fP(3X)

 .PP
 .PP

-Comparable functions in the wide-character (ncursesw) library are
-described in
-\fBcurs_add_wchstr\fP(3X).
+\fB\%curs_add_wchstr\fP(3X) describes comparable functions of the
+.I \%ncurses
+library in its wide-character configuration
+.RI ( \%ncursesw ).