diff options
Diffstat (limited to '')
| -rw-r--r-- | upstream/archlinux/man3/curs_insch.3x | 120 |
1 files changed, 78 insertions, 42 deletions
diff --git a/upstream/archlinux/man3/curs_insch.3x b/upstream/archlinux/man3/curs_insch.3x index 7534c93e..5b1e8ad6 100644 --- a/upstream/archlinux/man3/curs_insch.3x +++ b/upstream/archlinux/man3/curs_insch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,53 +27,89 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_insch.3x,v 1.22 2022/02/12 20:05:11 tom Exp $ -.TH curs_insch 3X "" -.ie \n(.g .ds `` \(lq -.el .ds `` `` -.ie \n(.g .ds '' \(rq -.el .ds '' '' +.\" $Id: curs_insch.3x,v 1.40 2024/04/20 19:03:47 tom Exp $ +.TH curs_insch 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 '' "" +.\} .SH NAME -\fBinsch\fP, -\fBwinsch\fP, -\fBmvinsch\fP, -\fBmvwinsch\fP \- insert a character before cursor in a \fBcurses\fP window +\fB\%insch\fP, +\fB\%winsch\fP, +\fB\%mvinsch\fP, +\fB\%mvwinsch\fP \- +insert a \fIcurses\fP character in a window .SH SYNOPSIS +.nf \fB#include <curses.h>\fP -.sp -\fBint insch(chtype \fIch\fB);\fR -.br -\fBint winsch(WINDOW *\fIwin\fB, chtype \fIch\fB);\fR -.sp -\fBint mvinsch(int \fIy\fB, int \fIx\fB, chtype \fIch\fB);\fR -.br -\fBint mvwinsch(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, chtype \fIch\fB);\fR -.br +.PP +\fBint insch(chtype \fIch\fP); +\fBint winsch(WINDOW *\fIwin\fP, chtype \fIch\fP); +\fBint mvinsch(int \fIy\fP, int \fIx\fP, chtype \fIch\fP); +\fBint mvwinsch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, chtype \fIch\fP); +.fi .SH DESCRIPTION -These routines insert the character \fIch\fP before the character under the -cursor. -All characters to the right of the cursor are moved one space to the -right, with the possibility of the rightmost character on the line being lost. -The insertion operation does not change the cursor position. -.SH RETURN VALUE -All routines that return an integer return \fBERR\fP upon failure and \fBOK\fP -(SVr4 specifies only "an integer value other than \fBERR\fP") -upon successful completion, -unless otherwise noted in the preceding routine descriptions. +These functions insert the +.I curses +character +.I ch +at the cursor in the specified window +.I win +(or +.BR \%stdscr ). +The character previously at the cursor and any to its right move one +cell to the right; +the rightmost character on the line is discarded. +The cursor does not advance. +.SH "RETURN VALUE" +These functions return +.B OK +on success and +.B ERR +on failure. +.PP +Functions taking a +.I \%WINDOW +pointer argument fail if the pointer is +.BR 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 -These routines do not necessarily imply use of a hardware insert character -feature. +.BR \%insch , +.BR \%mvinsch , +and +.B \%mvwinsch +may be implemented as macros. .PP -Note that \fBinsch\fP, \fBmvinsch\fP, and \fBmvwinsch\fP may be macros. +A terminal's +.B \%insert_character +.RB ( ich1 ) +capability +is not necessarily employed. .SH PORTABILITY -These functions are described in the XSI Curses standard, Issue 4. -.SH SEE ALSO -\fBcurses\fP(3X). +X/Open Curses, +Issue 4 describes these functions. +.PP +SVr4 +.I curses +describes a successful return value only as +\*(``an integer value other than +.BR ERR \*(''. +.SH "SEE ALSO" +\fB\%curs_ins_wch\fP(3X) describes comparable functions in the +wide-character +.I curses +configuration. .PP -Comparable functions in the wide-character (ncursesw) library are -described in -\fBcurs_ins_wch\fP(3X). +\fB\%curses\fP(3X), +\fB\%terminfo\fP(5) |