X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_addstr.3x;h=8db64ada9802d2674ac592e820540aa6dfc38b2f;hb=bd2d9c5734d2c66abe0b2ddd766695b200c154fe;hp=6d54ebbe4e78a03e71249730e11fb38ead366d6c;hpb=47d2fb4537d9ad5bb14f4810561a327930ca4280;p=ncurses.git diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x index 6d54ebbe..8db64ada 100644 --- a/man/curs_addstr.3x +++ b/man/curs_addstr.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2019,2020 Thomas E. Dickey * +.\" Copyright 2019-2022,2023 Thomas E. Dickey * .\" Copyright 1998-2012,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,64 +27,62 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_addstr.3x,v 1.20 2020/02/02 23:34:34 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.37 2023/11/18 21:18:55 tom Exp $ +.TH curs_addstr 3X 2023-11-18 "ncurses 6.4" "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\fR, -\fBaddnstr\fR, -\fBwaddstr\fR, -\fBwaddnstr\fR, -\fBmvaddstr\fR, -\fBmvaddnstr\fR, -\fBmvwaddstr\fR, -\fBmvwaddnstr\fR \- add a string of characters to a \fBcurses\fR 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 \fR +\fB#include .PP -\fBint addstr(const char *\fR\fIstr\fR\fB);\fR -.br -\fBint addnstr(const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR -.br -\fBint waddstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB);\fR -.br -\fBint waddnstr(WINDOW *\fR\fIwin\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR -.br -\fBint mvaddstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR -.br -\fBint mvaddnstr(int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB, int \fR\fIn\fR\fB);\fR -.br -\fBint mvwaddstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr\fR\fB);\fR -.br -\fBint mvwaddnstr(WINDOW *\fR\fIwin\fR\fB, int \fR\fIy\fR\fB, int \fR\fIx\fR\fB, const char *\fR\fIstr, int \fR\fIn\fR\fB);\fR +\fBint addstr(const char *\fIstr\fP); +\fBint addnstr(const char *\fIstr\fP, int \fIn\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 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); .fi .SH DESCRIPTION These functions write the (null-terminated) character string -\fIstr\fR on the given window. -It is similar to calling \fBwaddch\fR once for each character in the string. +\fIstr\fP on the given window. +It is similar to calling \fBwaddch\fP once for each byte in the string. .PP -The \fImv\fR functions perform cursor movement once, before writing any +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. .PP -The four functions with \fIn\fR as the last argument -write at most \fIn\fR characters, +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\fR is \-1, then the entire string will be added. +If \fIn\fP is \-1, then the entire string will be added. .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 @@ -99,9 +97,12 @@ 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 -All of these functions except \fBwaddnstr\fR may be macros. +All of these functions except \fBwaddnstr\fP may be macros. .SH PORTABILITY These functions are described in the XSI Curses standard, Issue 4. .SH SEE ALSO -\fBcurses\fR(3X), -\fBcurs_addch\fR(3X). +\fB\%curses\fP(3X), +\fB\%curs_addch\fP(3X), +\fB\%curs_addchstr\fP(3X), +\fB\%curs_addwstr\fP(3X), +\fB\%curs_add_wchstr\fP(3X)