diff options
Diffstat (limited to 'upstream/archlinux/man3/curs_addstr.3x')
| -rw-r--r-- | upstream/archlinux/man3/curs_addstr.3x | 154 |
1 files changed, 85 insertions, 69 deletions
diff --git a/upstream/archlinux/man3/curs_addstr.3x b/upstream/archlinux/man3/curs_addstr.3x index cd8ce48d..82c2844e 100644 --- a/upstream/archlinux/man3/curs_addstr.3x +++ b/upstream/archlinux/man3/curs_addstr.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 * @@ -27,93 +27,109 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addstr.3x,v 1.27 2023/03/11 20:40:52 tom Exp $ -.TH curs_addstr 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_addstr.3x,v 1.45 2024/04/20 19:18:18 tom Exp $ +.TH curs_addstr 3X 2024-04-20 "ncurses 6.5" "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 -\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 +\fB\%addstr\fP, +\fB\%addnstr\fP, +\fB\%waddstr\fP, +\fB\%waddnstr\fP, +\fB\%mvaddstr\fP, +\fB\%mvaddnstr\fP, +\fB\%mvwaddstr\fP, +\fB\%mvwaddnstr\fP \- +add a string to a \fIcurses\fR window and advance the cursor .SH SYNOPSIS .nf -\fB#include <curses.h>\fP +\fB#include <curses.h> .PP -\fBint addstr(const char *\fIstr\fB);\fR -.br -\fBint addnstr(const char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint waddstr(WINDOW *\fIwin\fB, const char *\fIstr\fB);\fR -.br -\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 -\fBint mvaddnstr(int \fIy\fB, int \fIx\fB, const char *\fIstr\fB, int \fIn\fB);\fR -.br -\fBint mvwaddstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr\fB);\fR -.br -\fBint mvwaddnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char *\fIstr, int \fIn\fB);\fR +\fBint addstr(const char *\fIstr\fP); +\fBint mvaddstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP); +\fBint mvwaddstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP); +\fBint waddstr(WINDOW *\fIwin\fP, const char *\fIstr\fP); +.PP +\fBint addnstr(const char *\fIstr\fP, int \fIn\fP); +\fBint mvaddnstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP); +\fBint mvwaddnstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\fP, int \fIn\fP); +\fBint waddnstr(WINDOW *\fIwin\fP, const char *\fIstr\fP, int \fIn\fP); .fi .SH DESCRIPTION -These functions write the (null-terminated) character string -\fIstr\fP on the given window. -It is similar to calling \fBwaddch\fP once for each byte in the string. +.B waddstr +writes the characters of the (null-terminated) string +.I str +to the window +.IR win . +Its process is similar to calling \fB\%waddch\fP(3X) for each +.I char +in +.IR str . +Control characters are processed as in \fB\%waddch\fP(3X). .PP -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. +.B waddnstr +writes at most +.I n +characters, +or until a terminating null character occurs in +.IR str . +If +.I n +is \-1, +.B +.B waddnstr +writes the entire string. .PP -The four functions with \fIn\fP as the last argument -write at most \fIn\fP bytes, -or until a terminating null is reached. -If \fIn\fP is \-1, then the entire string will be added. +\fB\%ncurses\fP(3X) describes the variants of these functions. .SH RETURN VALUE -All functions return the integer \fBERR\fP upon failure and \fBOK\fP on success. +These functions return +.B OK +on success and +.B ERR +on failure. .PP -X/Open does not define any error conditions. -This implementation returns an error +X/Open Curses does not specify any error conditions. +.I \%ncurses +returns an error .bP -if the window pointer is null or +if the window pointer is +.BR NULL , .bP -if the string pointer is null or +if the string pointer is +.BR NULL , +or .bP -if the corresponding calls to \fBwaddch\fP return an error. -.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. -If an error is returned by the \fBwmove\fP, -no characters are added to the window. +if an internal \fB\%waddch\fP(3X) call returns an error. .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(3X) is disabled. +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 of these functions except \fBwaddnstr\fP may be macros. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. +X/Open Curses, +Issue 4 describes these functions. .SH SEE ALSO -\fBcurses\fP(3X), -\fBcurs_addch\fP(3X). +\fB\%curs_addwstr\fP(3X) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). +.PP +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_addchstr\fP(3X) |