diff options
Diffstat (limited to 'contrib/ncurses/man/curs_addchstr.3x')
| -rw-r--r-- | contrib/ncurses/man/curs_addchstr.3x | 114 |
1 files changed, 60 insertions, 54 deletions
diff --git a/contrib/ncurses/man/curs_addchstr.3x b/contrib/ncurses/man/curs_addchstr.3x index 09d70d6e8e1f..25d322aff0be 100644 --- a/contrib/ncurses/man/curs_addchstr.3x +++ b/contrib/ncurses/man/curs_addchstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019,2020 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 * @@ -27,62 +27,61 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addchstr.3x,v 1.22 2020/12/19 21:39:20 tom Exp $ -.TH curs_addchstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_addchstr.3x,v 1.45 2024/04/20 21:20:07 tom Exp $ +.TH curs_addchstr 3X 2024-04-20 "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 .. -.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 -.ad -.hy +\fB\%addchstr\fP, +\fB\%addchnstr\fP, +\fB\%waddchstr\fP, +\fB\%waddchnstr\fP, +\fB\%mvaddchstr\fP, +\fB\%mvaddchnstr\fP, +\fB\%mvwaddchstr\fP, +\fB\%mvwaddchnstr\fP \- +add a \fIcurses\fR character string to a window .SH SYNOPSIS .nf -\fB#include <curses.h>\fR +\fB#include <curses.h> .PP -\fBint addchstr(const chtype *\fP\fIchstr\fP\fB);\fR -.br -\fBint addchnstr(const chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR -.br -\fBint waddchstr(WINDOW *\fP\fIwin\fP\fB, const chtype *\fP\fIchstr\fP\fB);\fR -.br -\fBint waddchnstr(WINDOW *\fP\fIwin\fP\fB, const chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR -.sp -\fBint mvaddchstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const chtype *\fP\fIchstr\fP\fB);\fR -.br -\fBint mvaddchnstr(int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR -.br -\fBint mvwaddchstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const chtype *\fP\fIchstr\fP\fB);\fR -.br -\fBint mvwaddchnstr(WINDOW *\fP\fIwin\fP\fB, int \fP\fIy\fP\fB, int \fP\fIx\fP\fB, const chtype *\fP\fIchstr\fP\fB, int \fP\fIn\fP\fB);\fR +\fBint addchstr(const chtype *\fIchstr\fP); +\fBint waddchstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP); +\fBint mvaddchstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP); +\fBint mvwaddchstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP); +.PP +\fBint addchnstr(const chtype *\fIchstr\fP, int \fIn\fP); +\fBint waddchnstr(WINDOW *\fIwin\fP, const chtype *\fIchstr\fP, int \fIn\fP); +\fBint mvaddchnstr(int \fIy\fP, int \fIx\fP, const chtype *\fIchstr\fP, int \fIn\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\fR array +\fIchstr\fP array 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, +.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. -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 -The window cursor is \fInot\fR advanced. -These functions work faster than \fBwaddnstr\fR. +The window cursor is \fInot\fP advanced. +These functions are faster than \fBwaddnstr\fP. On the other hand: .bP they do not perform checking @@ -95,23 +94,30 @@ 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 -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. +X/Open Curses does not specify any error conditions. 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, -or if the window pointer is null. +Functions prefixed with \*(``mv\*('' first perform cursor movement and +fail if the position +.RI ( y , +.IR x ) +is outside the window boundaries. .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. +These functions are described in X/Open Curses, Issue 4. .SH SEE ALSO -\fBcurses\fR(3X), -\fBcurs_addstr\fR(3X). +\fB\%curs_add_wchstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). .PP -Comparable functions in the wide-character (ncursesw) library are -described in -\fBcurs_add_wchstr\fR(3X). +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_addstr\fP(3X) |