diff options
Diffstat (limited to 'man/curs_delch.3x')
| -rw-r--r-- | man/curs_delch.3x | 56 |
1 files changed, 35 insertions, 21 deletions
diff --git a/man/curs_delch.3x b/man/curs_delch.3x index e62ecc130de1..e4bf86cba174 100644 --- a/man/curs_delch.3x +++ b/man/curs_delch.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2023,2024 Thomas E. Dickey * +.\" Copyright 2018-2024,2025 Thomas E. Dickey * .\" Copyright 1998-2006,2010 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -27,8 +27,8 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_delch.3x,v 1.34 2024/04/20 19:24:14 tom Exp $ -.TH curs_delch 3X 2024-04-20 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" +.\" $Id: curs_delch.3x,v 1.49 2025/04/05 21:59:53 tom Exp $ +.TH curs_delch 3X 2025-04-05 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .ie \n(.g \{\ .ds `` \(lq .ds '' \(rq @@ -39,6 +39,11 @@ .ie t .ds '' '' .el .ds '' "" .\} +. +.de bP +.ie n .IP \(bu 4 +.el .IP \(bu 2 +.. .SH NAME \fB\%delch\fP, \fB\%wdelch\fP, @@ -50,27 +55,25 @@ delete a character from a \fIcurses\fR window \fB#include <curses.h> .PP \fBint delch(void); -\fBint wdelch(WINDOW *\fIwin\fP); +\fBint wdelch(WINDOW * \fIwin\fP); \fBint mvdelch(int \fIy\fP, int \fIx\fP); -\fBint mvwdelch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP); +\fBint mvwdelch(WINDOW * \fIwin\fP, int \fIy\fP, int \fIx\fP); .fi .SH DESCRIPTION .B \%wdelch deletes the character at the cursor position in .IR win . -\fB\%ncurses\fP(3X) describes the variants of this function. -.PP -.B \%wdelch -moves all characters to the right of the cursor on the same line to the -left one position and replaces the contents of the rightmost position on -the line with the window's blank character; +It moves all characters to the right of the cursor on the same line to +the left one position and replaces the contents of the rightmost +position on the line with the window's background character; see \fB\%bkgd\fP(3X) -(wide-character API users may consult \fB\%bkgrnd\fP(3X) instead). +(wide-character API users: \fB\%bkgrnd\fP(3X)). The cursor position does not change (after moving to .RI ( y , .IR x ), if specified). +\fB\%ncurses\fP(3X) describes the variants of this function. .SH RETURN VALUE These functions return .B OK @@ -78,10 +81,20 @@ on success and .B ERR on failure. .PP -Functions taking a +In +.IR \%ncurses , +these functions fail if +.bP +the +.I curses +screen has not been initialized, +or +.bP +(for functions taking a .I \%WINDOW -pointer argument fail if the pointer is -.BR NULL . +pointer argument) +.I win +is a null pointer. .PP Functions prefixed with \*(``mv\*('' first perform cursor movement and fail if the position @@ -101,13 +114,14 @@ A terminal's capability is not necessarily employed. .SH PORTABILITY -X/Open Curses, -Issue 4 describes these functions. +X/Open Curses Issue\ 4 describes these functions. +It specifies no error conditions for them. .PP -SVr4 -.I curses -describes a successful return value only as +SVr4 describes a successful return value only as \*(``an integer value other than -.BR ERR \*(''. +.IR ERR \*(''. \" Courier roman in source; SVID 4, vol. 3, p. 489 +.SH HISTORY +SVr2 (1984) introduced +.IR \%wdelch "." .SH SEE ALSO \fB\%curses\fP(3X) |