ncurses 6.3 - patch 20220729

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

diff --git a/man/curs_addchstr.3x b/man/curs_addchstr.3x
index 44d1b79f35ca8ade44ab66ee625f6d752b837200..aba4c1317efbc01ef4f95ee4c0a52584232bbcc8 100644 (file)
--- a/man/curs_addchstr.3x
+++ b/man/curs_addchstr.3x
@@ -1,5 +1,6 @@
 .\"***************************************************************************
 .\"***************************************************************************

-.\" Copyright (c) 1998-2012,2017 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,8 +27,12 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: curs_addchstr.3x,v 1.17 2017/11/18 23:56:00 tom Exp $
+.\" $Id: curs_addchstr.3x,v 1.25 2022/02/12 20:07:29 tom Exp $

 .TH curs_addchstr 3X ""
 .TH curs_addchstr 3X ""

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

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


@@ -35,49 +40,49 @@
 .na
 .hy 0
 .SH NAME
 .na
 .hy 0
 .SH NAME

-\fBaddchstr\fR,
-\fBaddchnstr\fR,
-\fBwaddchstr\fR,
-\fBwaddchnstr\fR,
-\fBmvaddchstr\fR,
-\fBmvaddchnstr\fR,
-\fBmvwaddchstr\fR,
-\fBmvwaddchnstr\fR \- add a string of characters (and attributes) to a \fBcurses\fR window
+\fBaddchstr\fP,
+\fBaddchnstr\fP,
+\fBwaddchstr\fP,
+\fBwaddchnstr\fP,
+\fBmvaddchstr\fP,
+\fBmvaddchnstr\fP,
+\fBmvwaddchstr\fP,
+\fBmvwaddchnstr\fP \- add a string of characters (and attributes) to a \fBcurses\fP window

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

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

 .PP
 .PP

-\fBint addchstr(const chtype *chstr);\fR
+\fBint addchstr(const chtype *\fIchstr\fB);\fR

 .br
 .br

-\fBint addchnstr(const chtype *chstr, int n);\fR
+\fBint addchnstr(const chtype *\fIchstr\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint waddchstr(WINDOW *win, const chtype *chstr);\fR
+\fBint waddchstr(WINDOW *\fIwin\fB, const chtype *\fIchstr\fB);\fR

 .br
 .br

-\fBint waddchnstr(WINDOW *win, const chtype *chstr, int n);\fR
+\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
 .br

-\fBint mvaddchstr(int y, int x, const chtype *chstr);\fR
+\fBint mvaddchnstr(int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR

 .br
 .br

-\fBint mvaddchnstr(int y, int x, const chtype *chstr, int n);\fR
+\fBint mvwaddchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB);\fR

 .br
 .br

-\fBint mvwaddchstr(WINDOW *win, int y, int x, const chtype *chstr);\fR
-.br
-\fBint mvwaddchnstr(WINDOW *win, int y, int x, const chtype *chstr, int n);\fR
+\fBint mvwaddchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const chtype *\fIchstr\fB, int \fIn\fB);\fR

 .fi
 .SH DESCRIPTION
 These functions copy the (null-terminated)
 .fi
 .SH DESCRIPTION
 These functions copy the (null-terminated)

-\fIchstr\fR array
+\fIchstr\fP array

 into the window image structure
 starting at the current cursor position.
 into the window image structure
 starting at the current cursor position.

-The four functions with \fIn\fR as the last
-argument copy at most \fIn\fR elements,
+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.
 but no more than will fit on the line.

-If \fBn\fR=\fB\-1\fR then the whole array is copied,
+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
 to the maximum number of characters that will fit on the line.
 .PP

-The window cursor is \fInot\fR advanced.
-These functions work faster than \fBwaddnstr\fR.
+The window cursor is \fInot\fP advanced.
+These functions work faster than \fBwaddnstr\fP.

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


@@ -90,23 +95,23 @@ they do not expand other control characters to ^-escapes, and
 they truncate the string if it crosses the right margin,
 rather than wrapping it around to the new line.
 .SH RETURN VALUE
 they truncate the string if it crosses the right margin,
 rather than wrapping it around to the new line.
 .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
 if the window pointer is null.
 .PP
 .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
+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
 \fBwmove\fP, and return an error if the position is outside the window,
 or if the window pointer is null.
 .SH NOTES

-All functions except \fBwaddchnstr\fR may be macros.
+All functions except \fBwaddchnstr\fP may be macros.

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

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

 .PP
 Comparable functions in the wide-character (ncursesw) library are
 described in
 .PP
 Comparable functions in the wide-character (ncursesw) library are
 described in

-\fBcurs_add_wchstr\fR(3X).
+\fBcurs_add_wchstr\fP(3X).