diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:33 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-06-17 10:52:33 +0000 |
commit | 2c3307fb903f427be3d021c5780b75cac9af2ce8 (patch) | |
tree | 65cf431f40b7481d81ae2dfce9576342686448f7 /upstream/opensuse-tumbleweed/man3/addstr.3ncurses | |
parent | Releasing progress-linux version 4.22.0-1~progress7.99u1. (diff) | |
download | manpages-l10n-2c3307fb903f427be3d021c5780b75cac9af2ce8.tar.xz manpages-l10n-2c3307fb903f427be3d021c5780b75cac9af2ce8.zip |
Merging upstream version 4.23.0.
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/opensuse-tumbleweed/man3/addstr.3ncurses')
-rw-r--r-- | upstream/opensuse-tumbleweed/man3/addstr.3ncurses | 87 |
1 files changed, 57 insertions, 30 deletions
diff --git a/upstream/opensuse-tumbleweed/man3/addstr.3ncurses b/upstream/opensuse-tumbleweed/man3/addstr.3ncurses index 0a3f588c..d1ac45fa 100644 --- a/upstream/opensuse-tumbleweed/man3/addstr.3ncurses +++ b/upstream/opensuse-tumbleweed/man3/addstr.3ncurses @@ -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,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addstr.3x,v 1.37 2023/11/18 21:18:55 tom Exp $ -.TH addstr 3NCURSES 2023-11-18 "ncurses 6.4" "Library calls" +.\" $Id: curs_addstr.3x,v 1.45 2024/04/20 19:18:18 tom Exp $ +.TH addstr 3NCURSES 2024-04-20 "ncurses 6.5" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -59,50 +59,77 @@ add a string to a \fIcurses\fR window and advance the cursor \fB#include <ncursesw/curses.h> .PP \fBint addstr(const char *\fIstr\fP); -\fBint addnstr(const char *\fIstr\fP, int \fIn\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); -\fBint waddnstr(WINDOW *\fIwin\fP, const char *\fIstr\fP, int \fIn\fP); .PP -\fBint mvaddstr(int \fIy\fP, int \fIx\fP, const char *\fIstr\fP); +\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 mvwaddstr(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const char *\fIstr\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(3NCURSES) for each +.I char +in +.IR str . +Control characters are processed as in \fB\%waddch\fP(3NCURSES). .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(3NCURSES) 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. +if an internal \fB\%waddch\fP(3NCURSES) call returns 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. +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 +\fB\%addwstr\fP(3NCURSES) describes comparable functions of the +.I \%ncurses +library in its wide-character configuration +.RI ( \%ncursesw ). +.PP \fB\%ncurses\fP(3NCURSES), \fB\%addch\fP(3NCURSES), -\fB\%addchstr\fP(3NCURSES), -\fB\%addwstr\fP(3NCURSES), -\fB\%add_wchstr\fP(3NCURSES) +\fB\%addchstr\fP(3NCURSES) |