diff options
Diffstat (limited to 'usr/src/man/man3xcurses')
119 files changed, 16305 insertions, 0 deletions
diff --git a/usr/src/man/man3xcurses/COLS.3xcurses b/usr/src/man/man3xcurses/COLS.3xcurses new file mode 100644 index 0000000000..c117512f78 --- /dev/null +++ b/usr/src/man/man3xcurses/COLS.3xcurses @@ -0,0 +1,50 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH COLS 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +COLS \- number of columns on terminal screen +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR \fB/usr/xpg4/include\fR \fB-L\fR \fB/usr/xpg4/lib\fR \e +\fB-R\fR \fB/usr/xpg4/lib\fR \fB-lcurses\fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +extern int COLS; +.fi + +.SH DESCRIPTION +.sp +.LP +The external variable \fBCOLS\fR indicates the number of columns on the +terminal screen. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/LINES.3xcurses b/usr/src/man/man3xcurses/LINES.3xcurses new file mode 100644 index 0000000000..7ca62c1970 --- /dev/null +++ b/usr/src/man/man3xcurses/LINES.3xcurses @@ -0,0 +1,50 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH LINES 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +LINES \- number of lines on terminal screen +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR \fB/usr/xpg4/include\fR \fB-L\fR \fB/usr/xpg4/lib\fR \e +\fB-R\fR \fB/usr/xpg4/lib\fR \fB-lcurses\fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +extern int LINES; +.fi + +.SH DESCRIPTION +.sp +.LP +The external variable \fBLINES\fR indicates the number of lines on the terminal +screen. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/Makefile b/usr/src/man/man3xcurses/Makefile new file mode 100644 index 0000000000..b90fec8e09 --- /dev/null +++ b/usr/src/man/man3xcurses/Makefile @@ -0,0 +1,757 @@ +# +# This file and its contents are supplied under the terms of the +# Common Development and Distribution License ("CDDL"), version 1.0. +# You may only use this file in accordance with the terms of version +# 1.0 of the CDDL. +# +# A full copy of the text of the CDDL should have accompanied this +# source. A copy of the CDDL is also available via the Internet +# at http://www.illumos.org/license/CDDL. +# + +# Copyright 2011, Richard Lowe + +include ../../Makefile.master + +MANSECT = 3xcurses + +MANFILES = COLS.3xcurses \ + LINES.3xcurses \ + add_wch.3xcurses \ + add_wchnstr.3xcurses \ + addch.3xcurses \ + addchstr.3xcurses \ + addnstr.3xcurses \ + addnwstr.3xcurses \ + attr_get.3xcurses \ + attroff.3xcurses \ + baudrate.3xcurses \ + beep.3xcurses \ + bkgd.3xcurses \ + bkgrnd.3xcurses \ + border.3xcurses \ + border_set.3xcurses \ + can_change_color.3xcurses \ + cbreak.3xcurses \ + chgat.3xcurses \ + clear.3xcurses \ + clearok.3xcurses \ + clrtobot.3xcurses \ + clrtoeol.3xcurses \ + copywin.3xcurses \ + cur_term.3xcurses \ + curs_set.3xcurses \ + curscr.3xcurses \ + curses.3xcurses \ + def_prog_mode.3xcurses \ + del_curterm.3xcurses \ + delay_output.3xcurses \ + delch.3xcurses \ + deleteln.3xcurses \ + delscreen.3xcurses \ + delwin.3xcurses \ + derwin.3xcurses \ + doupdate.3xcurses \ + dupwin.3xcurses \ + echo.3xcurses \ + echo_wchar.3xcurses \ + echochar.3xcurses \ + endwin.3xcurses \ + erasechar.3xcurses \ + filter.3xcurses \ + flushinp.3xcurses \ + get_wch.3xcurses \ + getbegyx.3xcurses \ + getcchar.3xcurses \ + getch.3xcurses \ + getn_wstr.3xcurses \ + getnstr.3xcurses \ + getwin.3xcurses \ + halfdelay.3xcurses \ + has_ic.3xcurses \ + hline.3xcurses \ + hline_set.3xcurses \ + idcok.3xcurses \ + immedok.3xcurses \ + in_wch.3xcurses \ + in_wchnstr.3xcurses \ + inch.3xcurses \ + inchnstr.3xcurses \ + initscr.3xcurses \ + innstr.3xcurses \ + innwstr.3xcurses \ + ins_nwstr.3xcurses \ + ins_wch.3xcurses \ + insch.3xcurses \ + insdelln.3xcurses \ + insertln.3xcurses \ + insnstr.3xcurses \ + intrflush.3xcurses \ + is_linetouched.3xcurses \ + keyname.3xcurses \ + keypad.3xcurses \ + libcurses.3xcurses \ + longname.3xcurses \ + meta.3xcurses \ + move.3xcurses \ + mvcur.3xcurses \ + mvderwin.3xcurses \ + mvprintw.3xcurses \ + mvscanw.3xcurses \ + mvwin.3xcurses \ + napms.3xcurses \ + newpad.3xcurses \ + nl.3xcurses \ + nodelay.3xcurses \ + noqiflush.3xcurses \ + notimeout.3xcurses \ + overlay.3xcurses \ + pechochar.3xcurses \ + putp.3xcurses \ + redrawwin.3xcurses \ + resetty.3xcurses \ + ripoffline.3xcurses \ + scr_dump.3xcurses \ + scrl.3xcurses \ + set_term.3xcurses \ + setcchar.3xcurses \ + slk_attroff.3xcurses \ + standend.3xcurses \ + stdscr.3xcurses \ + syncok.3xcurses \ + termattrs.3xcurses \ + termname.3xcurses \ + tgetent.3xcurses \ + tigetflag.3xcurses \ + typeahead.3xcurses \ + unctrl.3xcurses \ + ungetch.3xcurses \ + use_env.3xcurses \ + vidattr.3xcurses \ + vw_printw.3xcurses \ + vw_scanw.3xcurses \ + vwprintw.3xcurses \ + vwscanw.3xcurses \ + wunctrl.3xcurses + +MANSOFILES = COLORS.3xcurses \ + COLOR_PAIR.3xcurses \ + COLOR_PAIRS.3xcurses \ + PAIR_NUMBER.3xcurses \ + add_wchstr.3xcurses \ + addchnstr.3xcurses \ + addstr.3xcurses \ + addwstr.3xcurses \ + attr_off.3xcurses \ + attr_on.3xcurses \ + attr_set.3xcurses \ + attron.3xcurses \ + attrset.3xcurses \ + bkgdset.3xcurses \ + bkgrndset.3xcurses \ + box.3xcurses \ + box_set.3xcurses \ + color_content.3xcurses \ + color_set.3xcurses \ + def_shell_mode.3xcurses \ + erase.3xcurses \ + erasewchar.3xcurses \ + flash.3xcurses \ + get_wstr.3xcurses \ + getbkgd.3xcurses \ + getbkgrnd.3xcurses \ + getmaxyx.3xcurses \ + getparyx.3xcurses \ + getstr.3xcurses \ + getyx.3xcurses \ + has_colors.3xcurses \ + has_il.3xcurses \ + idlok.3xcurses \ + in_wchstr.3xcurses \ + inchstr.3xcurses \ + init_color.3xcurses \ + init_pair.3xcurses \ + ins_wstr.3xcurses \ + insstr.3xcurses \ + instr.3xcurses \ + inwstr.3xcurses \ + is_wintouched.3xcurses \ + isendwin.3xcurses \ + key_name.3xcurses \ + killchar.3xcurses \ + killwchar.3xcurses \ + leaveok.3xcurses \ + mvadd_wch.3xcurses \ + mvadd_wchnstr.3xcurses \ + mvadd_wchstr.3xcurses \ + mvaddch.3xcurses \ + mvaddchnstr.3xcurses \ + mvaddchstr.3xcurses \ + mvaddnstr.3xcurses \ + mvaddnwstr.3xcurses \ + mvaddstr.3xcurses \ + mvaddwstr.3xcurses \ + mvchgat.3xcurses \ + mvdelch.3xcurses \ + mvget_wch.3xcurses \ + mvget_wstr.3xcurses \ + mvgetch.3xcurses \ + mvgetn_wstr.3xcurses \ + mvgetnstr.3xcurses \ + mvgetstr.3xcurses \ + mvhline.3xcurses \ + mvhline_set.3xcurses \ + mvin_wch.3xcurses \ + mvin_wchnstr.3xcurses \ + mvin_wchstr.3xcurses \ + mvinch.3xcurses \ + mvinchnstr.3xcurses \ + mvinchstr.3xcurses \ + mvinnstr.3xcurses \ + mvinnwstr.3xcurses \ + mvins_nwstr.3xcurses \ + mvins_wch.3xcurses \ + mvins_wstr.3xcurses \ + mvinsch.3xcurses \ + mvinsnstr.3xcurses \ + mvinsstr.3xcurses \ + mvinstr.3xcurses \ + mvinwstr.3xcurses \ + mvvline.3xcurses \ + mvvline_set.3xcurses \ + mvwadd_wch.3xcurses \ + mvwadd_wchnstr.3xcurses \ + mvwadd_wchstr.3xcurses \ + mvwaddch.3xcurses \ + mvwaddchnstr.3xcurses \ + mvwaddchstr.3xcurses \ + mvwaddnstr.3xcurses \ + mvwaddnwstr.3xcurses \ + mvwaddstr.3xcurses \ + mvwaddwstr.3xcurses \ + mvwchgat.3xcurses \ + mvwdelch.3xcurses \ + mvwget_wch.3xcurses \ + mvwget_wstr.3xcurses \ + mvwgetch.3xcurses \ + mvwgetn_wstr.3xcurses \ + mvwgetnstr.3xcurses \ + mvwgetstr.3xcurses \ + mvwhline.3xcurses \ + mvwhline_set.3xcurses \ + mvwin_wch.3xcurses \ + mvwin_wchnstr.3xcurses \ + mvwin_wchstr.3xcurses \ + mvwinch.3xcurses \ + mvwinchnstr.3xcurses \ + mvwinchstr.3xcurses \ + mvwinnstr.3xcurses \ + mvwinnwstr.3xcurses \ + mvwins_nwstr.3xcurses \ + mvwins_wch.3xcurses \ + mvwins_wstr.3xcurses \ + mvwinsch.3xcurses \ + mvwinsnstr.3xcurses \ + mvwinsstr.3xcurses \ + mvwinstr.3xcurses \ + mvwinwstr.3xcurses \ + mvwprintw.3xcurses \ + mvwscanw.3xcurses \ + mvwvline.3xcurses \ + mvwvline_set.3xcurses \ + newterm.3xcurses \ + newwin.3xcurses \ + nocbreak.3xcurses \ + noecho.3xcurses \ + nonl.3xcurses \ + noraw.3xcurses \ + overwrite.3xcurses \ + pair_content.3xcurses \ + pecho_wchar.3xcurses \ + pnoutrefresh.3xcurses \ + prefresh.3xcurses \ + printw.3xcurses \ + putwin.3xcurses \ + qiflush.3xcurses \ + raw.3xcurses \ + refresh.3xcurses \ + reset_prog_mode.3xcurses \ + reset_shell_mode.3xcurses \ + restartterm.3xcurses \ + savetty.3xcurses \ + scanw.3xcurses \ + scr_init.3xcurses \ + scr_restore.3xcurses \ + scr_set.3xcurses \ + scroll.3xcurses \ + scrollok.3xcurses \ + set_curterm.3xcurses \ + setscrreg.3xcurses \ + setupterm.3xcurses \ + slk_attr_off.3xcurses \ + slk_attr_on.3xcurses \ + slk_attr_set.3xcurses \ + slk_attron.3xcurses \ + slk_attrset.3xcurses \ + slk_clear.3xcurses \ + slk_color.3xcurses \ + slk_init.3xcurses \ + slk_label.3xcurses \ + slk_noutrefresh.3xcurses \ + slk_refresh.3xcurses \ + slk_restore.3xcurses \ + slk_set.3xcurses \ + slk_touch.3xcurses \ + slk_wset.3xcurses \ + standout.3xcurses \ + start_color.3xcurses \ + subpad.3xcurses \ + subwin.3xcurses \ + term_attrs.3xcurses \ + tgetflag.3xcurses \ + tgetnum.3xcurses \ + tgetstr.3xcurses \ + tgoto.3xcurses \ + tigetnum.3xcurses \ + tigetstr.3xcurses \ + timeout.3xcurses \ + touchline.3xcurses \ + touchwin.3xcurses \ + tparm.3xcurses \ + tputs.3xcurses \ + unget_wch.3xcurses \ + untouchwin.3xcurses \ + vid_attr.3xcurses \ + vid_puts.3xcurses \ + vidputs.3xcurses \ + vline.3xcurses \ + vline_set.3xcurses \ + wadd_wch.3xcurses \ + wadd_wchnstr.3xcurses \ + wadd_wchstr.3xcurses \ + waddch.3xcurses \ + waddchnstr.3xcurses \ + waddchstr.3xcurses \ + waddnstr.3xcurses \ + waddnwstr.3xcurses \ + waddstr.3xcurses \ + waddwstr.3xcurses \ + wattr_get.3xcurses \ + wattr_off.3xcurses \ + wattr_on.3xcurses \ + wattr_set.3xcurses \ + wattroff.3xcurses \ + wattron.3xcurses \ + wattrset.3xcurses \ + wbkgd.3xcurses \ + wbkgdset.3xcurses \ + wbkgrnd.3xcurses \ + wbkgrndset.3xcurses \ + wborder.3xcurses \ + wborder_set.3xcurses \ + wchgat.3xcurses \ + wclear.3xcurses \ + wclrtobot.3xcurses \ + wclrtoeol.3xcurses \ + wcolor_set.3xcurses \ + wcursyncup.3xcurses \ + wdelch.3xcurses \ + wdeleteln.3xcurses \ + wecho_wchar.3xcurses \ + wechochar.3xcurses \ + werase.3xcurses \ + wget_wch.3xcurses \ + wget_wstr.3xcurses \ + wgetbkgrnd.3xcurses \ + wgetch.3xcurses \ + wgetn_wstr.3xcurses \ + wgetnstr.3xcurses \ + wgetstr.3xcurses \ + whline.3xcurses \ + whline_set.3xcurses \ + win_wch.3xcurses \ + win_wchnstr.3xcurses \ + win_wchstr.3xcurses \ + winch.3xcurses \ + winchnstr.3xcurses \ + winchstr.3xcurses \ + winnstr.3xcurses \ + winnwstr.3xcurses \ + wins_nwstr.3xcurses \ + wins_wch.3xcurses \ + wins_wstr.3xcurses \ + winsch.3xcurses \ + winsdelln.3xcurses \ + winsertln.3xcurses \ + winsnstr.3xcurses \ + winsstr.3xcurses \ + winstr.3xcurses \ + winwstr.3xcurses \ + wmove.3xcurses \ + wnoutrefresh.3xcurses \ + wprintw.3xcurses \ + wredrawln.3xcurses \ + wrefresh.3xcurses \ + wscanw.3xcurses \ + wscrl.3xcurses \ + wsetscrreg.3xcurses \ + wstandend.3xcurses \ + wstandout.3xcurses \ + wsyncdown.3xcurses \ + wsyncup.3xcurses \ + wtimeout.3xcurses \ + wtouchln.3xcurses \ + wvline.3xcurses \ + wvline_set.3xcurses + +MANFILES += $(MANSOFILES) + +mvadd_wch.3xcurses := SOSRC = man3xcurses/add_wch.3xcurses +mvwadd_wch.3xcurses := SOSRC = man3xcurses/add_wch.3xcurses +wadd_wch.3xcurses := SOSRC = man3xcurses/add_wch.3xcurses + +add_wchstr.3xcurses := SOSRC = man3xcurses/add_wchnstr.3xcurses +mvadd_wchnstr.3xcurses := SOSRC = man3xcurses/add_wchnstr.3xcurses +mvadd_wchstr.3xcurses := SOSRC = man3xcurses/add_wchnstr.3xcurses +mvwadd_wchnstr.3xcurses := SOSRC = man3xcurses/add_wchnstr.3xcurses +mvwadd_wchstr.3xcurses := SOSRC = man3xcurses/add_wchnstr.3xcurses +wadd_wchnstr.3xcurses := SOSRC = man3xcurses/add_wchnstr.3xcurses +wadd_wchstr.3xcurses := SOSRC = man3xcurses/add_wchnstr.3xcurses + +mvaddch.3xcurses := SOSRC = man3xcurses/addch.3xcurses +mvwaddch.3xcurses := SOSRC = man3xcurses/addch.3xcurses +waddch.3xcurses := SOSRC = man3xcurses/addch.3xcurses + +addchnstr.3xcurses := SOSRC = man3xcurses/addchstr.3xcurses +mvaddchnstr.3xcurses := SOSRC = man3xcurses/addchstr.3xcurses +mvaddchstr.3xcurses := SOSRC = man3xcurses/addchstr.3xcurses +mvwaddchnstr.3xcurses := SOSRC = man3xcurses/addchstr.3xcurses +mvwaddchstr.3xcurses := SOSRC = man3xcurses/addchstr.3xcurses +waddchnstr.3xcurses := SOSRC = man3xcurses/addchstr.3xcurses +waddchstr.3xcurses := SOSRC = man3xcurses/addchstr.3xcurses + +addstr.3xcurses := SOSRC = man3xcurses/addnstr.3xcurses +mvaddnstr.3xcurses := SOSRC = man3xcurses/addnstr.3xcurses +mvaddstr.3xcurses := SOSRC = man3xcurses/addnstr.3xcurses +mvwaddnstr.3xcurses := SOSRC = man3xcurses/addnstr.3xcurses +mvwaddstr.3xcurses := SOSRC = man3xcurses/addnstr.3xcurses +waddnstr.3xcurses := SOSRC = man3xcurses/addnstr.3xcurses +waddstr.3xcurses := SOSRC = man3xcurses/addnstr.3xcurses + +addwstr.3xcurses := SOSRC = man3xcurses/addnwstr.3xcurses +mvaddnwstr.3xcurses := SOSRC = man3xcurses/addnwstr.3xcurses +mvaddwstr.3xcurses := SOSRC = man3xcurses/addnwstr.3xcurses +mvwaddnwstr.3xcurses := SOSRC = man3xcurses/addnwstr.3xcurses +mvwaddwstr.3xcurses := SOSRC = man3xcurses/addnwstr.3xcurses +waddnwstr.3xcurses := SOSRC = man3xcurses/addnwstr.3xcurses +waddwstr.3xcurses := SOSRC = man3xcurses/addnwstr.3xcurses + +attr_off.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +attr_on.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +attr_set.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +color_set.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +wattr_get.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +wattr_off.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +wattr_on.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +wattr_set.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses +wcolor_set.3xcurses := SOSRC = man3xcurses/attr_get.3xcurses + +attron.3xcurses := SOSRC = man3xcurses/attroff.3xcurses +attrset.3xcurses := SOSRC = man3xcurses/attroff.3xcurses +wattroff.3xcurses := SOSRC = man3xcurses/attroff.3xcurses +wattron.3xcurses := SOSRC = man3xcurses/attroff.3xcurses +wattrset.3xcurses := SOSRC = man3xcurses/attroff.3xcurses + +flash.3xcurses := SOSRC = man3xcurses/beep.3xcurses + +bkgdset.3xcurses := SOSRC = man3xcurses/bkgd.3xcurses +getbkgd.3xcurses := SOSRC = man3xcurses/bkgd.3xcurses +wbkgd.3xcurses := SOSRC = man3xcurses/bkgd.3xcurses +wbkgdset.3xcurses := SOSRC = man3xcurses/bkgd.3xcurses + +bkgrndset.3xcurses := SOSRC = man3xcurses/bkgrnd.3xcurses +getbkgrnd.3xcurses := SOSRC = man3xcurses/bkgrnd.3xcurses +wbkgrnd.3xcurses := SOSRC = man3xcurses/bkgrnd.3xcurses +wbkgrndset.3xcurses := SOSRC = man3xcurses/bkgrnd.3xcurses +wgetbkgrnd.3xcurses := SOSRC = man3xcurses/bkgrnd.3xcurses + +box.3xcurses := SOSRC = man3xcurses/border.3xcurses +wborder.3xcurses := SOSRC = man3xcurses/border.3xcurses + +box_set.3xcurses := SOSRC = man3xcurses/border_set.3xcurses +wborder_set.3xcurses := SOSRC = man3xcurses/border_set.3xcurses + +COLORS.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +COLOR_PAIR.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +COLOR_PAIRS.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +PAIR_NUMBER.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +color_content.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +has_colors.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +init_color.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +init_pair.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +pair_content.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses +start_color.3xcurses := SOSRC = man3xcurses/can_change_color.3xcurses + +nocbreak.3xcurses := SOSRC = man3xcurses/cbreak.3xcurses +noraw.3xcurses := SOSRC = man3xcurses/cbreak.3xcurses +raw.3xcurses := SOSRC = man3xcurses/cbreak.3xcurses + +mvchgat.3xcurses := SOSRC = man3xcurses/chgat.3xcurses +mvwchgat.3xcurses := SOSRC = man3xcurses/chgat.3xcurses +wchgat.3xcurses := SOSRC = man3xcurses/chgat.3xcurses + +erase.3xcurses := SOSRC = man3xcurses/clear.3xcurses +wclear.3xcurses := SOSRC = man3xcurses/clear.3xcurses +werase.3xcurses := SOSRC = man3xcurses/clear.3xcurses + +idlok.3xcurses := SOSRC = man3xcurses/clearok.3xcurses +leaveok.3xcurses := SOSRC = man3xcurses/clearok.3xcurses +scrollok.3xcurses := SOSRC = man3xcurses/clearok.3xcurses +setscrreg.3xcurses := SOSRC = man3xcurses/clearok.3xcurses +wsetscrreg.3xcurses := SOSRC = man3xcurses/clearok.3xcurses + +wclrtobot.3xcurses := SOSRC = man3xcurses/clrtobot.3xcurses +wclrtoeol.3xcurses := SOSRC = man3xcurses/clrtoeol.3xcurses + +def_shell_mode.3xcurses := SOSRC = man3xcurses/def_prog_mode.3xcurses +reset_prog_mode.3xcurses := SOSRC = man3xcurses/def_prog_mode.3xcurses +reset_shell_mode.3xcurses := SOSRC = man3xcurses/def_prog_mode.3xcurses + +restartterm.3xcurses := SOSRC = man3xcurses/del_curterm.3xcurses +set_curterm.3xcurses := SOSRC = man3xcurses/del_curterm.3xcurses +setupterm.3xcurses := SOSRC = man3xcurses/del_curterm.3xcurses + +mvdelch.3xcurses := SOSRC = man3xcurses/delch.3xcurses +mvwdelch.3xcurses := SOSRC = man3xcurses/delch.3xcurses +wdelch.3xcurses := SOSRC = man3xcurses/delch.3xcurses + +wdeleteln.3xcurses := SOSRC = man3xcurses/deleteln.3xcurses + +newwin.3xcurses := SOSRC = man3xcurses/derwin.3xcurses +subwin.3xcurses := SOSRC = man3xcurses/derwin.3xcurses + +refresh.3xcurses := SOSRC = man3xcurses/doupdate.3xcurses +wnoutrefresh.3xcurses := SOSRC = man3xcurses/doupdate.3xcurses +wrefresh.3xcurses := SOSRC = man3xcurses/doupdate.3xcurses + +noecho.3xcurses := SOSRC = man3xcurses/echo.3xcurses + +wecho_wchar.3xcurses := SOSRC = man3xcurses/echo_wchar.3xcurses + +wechochar.3xcurses := SOSRC = man3xcurses/echochar.3xcurses + +isendwin.3xcurses := SOSRC = man3xcurses/endwin.3xcurses + +erasewchar.3xcurses := SOSRC = man3xcurses/erasechar.3xcurses +killchar.3xcurses := SOSRC = man3xcurses/erasechar.3xcurses +killwchar.3xcurses := SOSRC = man3xcurses/erasechar.3xcurses + +mvget_wch.3xcurses := SOSRC = man3xcurses/get_wch.3xcurses +mvwget_wch.3xcurses := SOSRC = man3xcurses/get_wch.3xcurses +wget_wch.3xcurses := SOSRC = man3xcurses/get_wch.3xcurses + +getmaxyx.3xcurses := SOSRC = man3xcurses/getbegyx.3xcurses +getparyx.3xcurses := SOSRC = man3xcurses/getbegyx.3xcurses +getyx.3xcurses := SOSRC = man3xcurses/getbegyx.3xcurses + +mvgetch.3xcurses := SOSRC = man3xcurses/getch.3xcurses +mvwgetch.3xcurses := SOSRC = man3xcurses/getch.3xcurses +wgetch.3xcurses := SOSRC = man3xcurses/getch.3xcurses + +get_wstr.3xcurses := SOSRC = man3xcurses/getn_wstr.3xcurses +mvget_wstr.3xcurses := SOSRC = man3xcurses/getn_wstr.3xcurses +mvgetn_wstr.3xcurses := SOSRC = man3xcurses/getn_wstr.3xcurses +mvwget_wstr.3xcurses := SOSRC = man3xcurses/getn_wstr.3xcurses +mvwgetn_wstr.3xcurses := SOSRC = man3xcurses/getn_wstr.3xcurses +wget_wstr.3xcurses := SOSRC = man3xcurses/getn_wstr.3xcurses +wgetn_wstr.3xcurses := SOSRC = man3xcurses/getn_wstr.3xcurses + +getstr.3xcurses := SOSRC = man3xcurses/getnstr.3xcurses +mvgetnstr.3xcurses := SOSRC = man3xcurses/getnstr.3xcurses +mvgetstr.3xcurses := SOSRC = man3xcurses/getnstr.3xcurses +mvwgetnstr.3xcurses := SOSRC = man3xcurses/getnstr.3xcurses +mvwgetstr.3xcurses := SOSRC = man3xcurses/getnstr.3xcurses +wgetnstr.3xcurses := SOSRC = man3xcurses/getnstr.3xcurses +wgetstr.3xcurses := SOSRC = man3xcurses/getnstr.3xcurses + +putwin.3xcurses := SOSRC = man3xcurses/getwin.3xcurses + +has_il.3xcurses := SOSRC = man3xcurses/has_ic.3xcurses + +mvhline.3xcurses := SOSRC = man3xcurses/hline.3xcurses +mvvline.3xcurses := SOSRC = man3xcurses/hline.3xcurses +mvwhline.3xcurses := SOSRC = man3xcurses/hline.3xcurses +mvwvline.3xcurses := SOSRC = man3xcurses/hline.3xcurses +vline.3xcurses := SOSRC = man3xcurses/hline.3xcurses +whline.3xcurses := SOSRC = man3xcurses/hline.3xcurses +wvline.3xcurses := SOSRC = man3xcurses/hline.3xcurses + +mvhline_set.3xcurses := SOSRC = man3xcurses/hline_set.3xcurses +mvvline_set.3xcurses := SOSRC = man3xcurses/hline_set.3xcurses +mvwhline_set.3xcurses := SOSRC = man3xcurses/hline_set.3xcurses +mvwvline_set.3xcurses := SOSRC = man3xcurses/hline_set.3xcurses +vline_set.3xcurses := SOSRC = man3xcurses/hline_set.3xcurses +whline_set.3xcurses := SOSRC = man3xcurses/hline_set.3xcurses +wvline_set.3xcurses := SOSRC = man3xcurses/hline_set.3xcurses + +mvin_wch.3xcurses := SOSRC = man3xcurses/in_wch.3xcurses +mvwin_wch.3xcurses := SOSRC = man3xcurses/in_wch.3xcurses +win_wch.3xcurses := SOSRC = man3xcurses/in_wch.3xcurses + +in_wchstr.3xcurses := SOSRC = man3xcurses/in_wchnstr.3xcurses +mvin_wchnstr.3xcurses := SOSRC = man3xcurses/in_wchnstr.3xcurses +mvin_wchstr.3xcurses := SOSRC = man3xcurses/in_wchnstr.3xcurses +mvwin_wchnstr.3xcurses := SOSRC = man3xcurses/in_wchnstr.3xcurses +mvwin_wchstr.3xcurses := SOSRC = man3xcurses/in_wchnstr.3xcurses +win_wchnstr.3xcurses := SOSRC = man3xcurses/in_wchnstr.3xcurses +win_wchstr.3xcurses := SOSRC = man3xcurses/in_wchnstr.3xcurses + +mvinch.3xcurses := SOSRC = man3xcurses/inch.3xcurses +mvwinch.3xcurses := SOSRC = man3xcurses/inch.3xcurses +winch.3xcurses := SOSRC = man3xcurses/inch.3xcurses + +inchstr.3xcurses := SOSRC = man3xcurses/inchnstr.3xcurses +mvinchnstr.3xcurses := SOSRC = man3xcurses/inchnstr.3xcurses +mvinchstr.3xcurses := SOSRC = man3xcurses/inchnstr.3xcurses +mvwinchnstr.3xcurses := SOSRC = man3xcurses/inchnstr.3xcurses +mvwinchstr.3xcurses := SOSRC = man3xcurses/inchnstr.3xcurses +winchnstr.3xcurses := SOSRC = man3xcurses/inchnstr.3xcurses +winchstr.3xcurses := SOSRC = man3xcurses/inchnstr.3xcurses + +newterm.3xcurses := SOSRC = man3xcurses/initscr.3xcurses + +instr.3xcurses := SOSRC = man3xcurses/innstr.3xcurses +mvinnstr.3xcurses := SOSRC = man3xcurses/innstr.3xcurses +mvinstr.3xcurses := SOSRC = man3xcurses/innstr.3xcurses +mvwinnstr.3xcurses := SOSRC = man3xcurses/innstr.3xcurses +mvwinstr.3xcurses := SOSRC = man3xcurses/innstr.3xcurses +winnstr.3xcurses := SOSRC = man3xcurses/innstr.3xcurses +winstr.3xcurses := SOSRC = man3xcurses/innstr.3xcurses + +inwstr.3xcurses := SOSRC = man3xcurses/innwstr.3xcurses +mvinnwstr.3xcurses := SOSRC = man3xcurses/innwstr.3xcurses +mvinwstr.3xcurses := SOSRC = man3xcurses/innwstr.3xcurses +mvwinnwstr.3xcurses := SOSRC = man3xcurses/innwstr.3xcurses +mvwinwstr.3xcurses := SOSRC = man3xcurses/innwstr.3xcurses +winnwstr.3xcurses := SOSRC = man3xcurses/innwstr.3xcurses +winwstr.3xcurses := SOSRC = man3xcurses/innwstr.3xcurses + +ins_wstr.3xcurses := SOSRC = man3xcurses/ins_nwstr.3xcurses +mvins_nwstr.3xcurses := SOSRC = man3xcurses/ins_nwstr.3xcurses +mvins_wstr.3xcurses := SOSRC = man3xcurses/ins_nwstr.3xcurses +mvwins_nwstr.3xcurses := SOSRC = man3xcurses/ins_nwstr.3xcurses +mvwins_wstr.3xcurses := SOSRC = man3xcurses/ins_nwstr.3xcurses +wins_nwstr.3xcurses := SOSRC = man3xcurses/ins_nwstr.3xcurses +wins_wstr.3xcurses := SOSRC = man3xcurses/ins_nwstr.3xcurses + +mvins_wch.3xcurses := SOSRC = man3xcurses/ins_wch.3xcurses +mvwins_wch.3xcurses := SOSRC = man3xcurses/ins_wch.3xcurses +wins_wch.3xcurses := SOSRC = man3xcurses/ins_wch.3xcurses + +mvinsch.3xcurses := SOSRC = man3xcurses/insch.3xcurses +mvwinsch.3xcurses := SOSRC = man3xcurses/insch.3xcurses +winsch.3xcurses := SOSRC = man3xcurses/insch.3xcurses + +winsdelln.3xcurses := SOSRC = man3xcurses/insdelln.3xcurses +winsertln.3xcurses := SOSRC = man3xcurses/insertln.3xcurses + +insstr.3xcurses := SOSRC = man3xcurses/insnstr.3xcurses +mvinsnstr.3xcurses := SOSRC = man3xcurses/insnstr.3xcurses +mvinsstr.3xcurses := SOSRC = man3xcurses/insnstr.3xcurses +mvwinsnstr.3xcurses := SOSRC = man3xcurses/insnstr.3xcurses +mvwinsstr.3xcurses := SOSRC = man3xcurses/insnstr.3xcurses +winsnstr.3xcurses := SOSRC = man3xcurses/insnstr.3xcurses +winsstr.3xcurses := SOSRC = man3xcurses/insnstr.3xcurses + +is_wintouched.3xcurses := SOSRC = man3xcurses/is_linetouched.3xcurses +touchline.3xcurses := SOSRC = man3xcurses/is_linetouched.3xcurses +touchwin.3xcurses := SOSRC = man3xcurses/is_linetouched.3xcurses +untouchwin.3xcurses := SOSRC = man3xcurses/is_linetouched.3xcurses +wtouchln.3xcurses := SOSRC = man3xcurses/is_linetouched.3xcurses + +key_name.3xcurses := SOSRC = man3xcurses/keyname.3xcurses + +wmove.3xcurses := SOSRC = man3xcurses/move.3xcurses + +mvwprintw.3xcurses := SOSRC = man3xcurses/mvprintw.3xcurses +printw.3xcurses := SOSRC = man3xcurses/mvprintw.3xcurses +wprintw.3xcurses := SOSRC = man3xcurses/mvprintw.3xcurses + +mvwscanw.3xcurses := SOSRC = man3xcurses/mvscanw.3xcurses +scanw.3xcurses := SOSRC = man3xcurses/mvscanw.3xcurses +wscanw.3xcurses := SOSRC = man3xcurses/mvscanw.3xcurses + +pnoutrefresh.3xcurses := SOSRC = man3xcurses/newpad.3xcurses +prefresh.3xcurses := SOSRC = man3xcurses/newpad.3xcurses +subpad.3xcurses := SOSRC = man3xcurses/newpad.3xcurses + +nonl.3xcurses := SOSRC = man3xcurses/nl.3xcurses + +qiflush.3xcurses := SOSRC = man3xcurses/noqiflush.3xcurses + +timeout.3xcurses := SOSRC = man3xcurses/notimeout.3xcurses +wtimeout.3xcurses := SOSRC = man3xcurses/notimeout.3xcurses + +overwrite.3xcurses := SOSRC = man3xcurses/overlay.3xcurses + +pecho_wchar.3xcurses := SOSRC = man3xcurses/pechochar.3xcurses + +tputs.3xcurses := SOSRC = man3xcurses/putp.3xcurses + +wredrawln.3xcurses := SOSRC = man3xcurses/redrawwin.3xcurses + +savetty.3xcurses := SOSRC = man3xcurses/resetty.3xcurses + +scr_init.3xcurses := SOSRC = man3xcurses/scr_dump.3xcurses +scr_restore.3xcurses := SOSRC = man3xcurses/scr_dump.3xcurses +scr_set.3xcurses := SOSRC = man3xcurses/scr_dump.3xcurses + +scroll.3xcurses := SOSRC = man3xcurses/scrl.3xcurses +wscrl.3xcurses := SOSRC = man3xcurses/scrl.3xcurses + +slk_attr_off.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_attr_on.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_attr_set.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_attron.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_attrset.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_clear.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_color.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_init.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_label.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_noutrefresh.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_refresh.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_restore.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_set.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_touch.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses +slk_wset.3xcurses := SOSRC = man3xcurses/slk_attroff.3xcurses + +standout.3xcurses := SOSRC = man3xcurses/standend.3xcurses +wstandend.3xcurses := SOSRC = man3xcurses/standend.3xcurses +wstandout.3xcurses := SOSRC = man3xcurses/standend.3xcurses + +wcursyncup.3xcurses := SOSRC = man3xcurses/syncok.3xcurses +wsyncdown.3xcurses := SOSRC = man3xcurses/syncok.3xcurses +wsyncup.3xcurses := SOSRC = man3xcurses/syncok.3xcurses + +term_attrs.3xcurses := SOSRC = man3xcurses/termattrs.3xcurses + +tgetflag.3xcurses := SOSRC = man3xcurses/tgetent.3xcurses +tgetnum.3xcurses := SOSRC = man3xcurses/tgetent.3xcurses +tgetstr.3xcurses := SOSRC = man3xcurses/tgetent.3xcurses +tgoto.3xcurses := SOSRC = man3xcurses/tgetent.3xcurses + +tigetnum.3xcurses := SOSRC = man3xcurses/tigetflag.3xcurses +tigetstr.3xcurses := SOSRC = man3xcurses/tigetflag.3xcurses +tparm.3xcurses := SOSRC = man3xcurses/tigetflag.3xcurses + +unget_wch.3xcurses := SOSRC = man3xcurses/ungetch.3xcurses + +vid_attr.3xcurses := SOSRC = man3xcurses/vidattr.3xcurses +vid_puts.3xcurses := SOSRC = man3xcurses/vidattr.3xcurses +vidputs.3xcurses := SOSRC = man3xcurses/vidattr.3xcurses + +.KEEP_STATE: + +include ../Makefile.man + +install: $(ROOTMANFILES) diff --git a/usr/src/man/man3xcurses/add_wch.3xcurses b/usr/src/man/man3xcurses/add_wch.3xcurses new file mode 100644 index 0000000000..b175aee735 --- /dev/null +++ b/usr/src/man/man3xcurses/add_wch.3xcurses @@ -0,0 +1,156 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH add_wch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +add_wch, mvadd_wch, mvwadd_wch, wadd_wch \- add a complex character (with +rendition) to a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +\fBint\fR \fBadd_wch\fR(\fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwadd_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvadd_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwadd_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBadd_wch()\fR function writes a complex character to the \fBstdscr\fR +window at the current cursor position. The \fBmvadd_wch()\fR and +\fBmvwadd_wch()\fR functions write the character to the position indicated by +the \fIx\fR (column) and \fIy\fR (row) parameters. The \fBmvadd_wch()\fR +function writes the character to the \fBstdscr\fR window, while +\fBmvwadd_wch()\fR writes the character to the window specified by \fIwin\fR. +The \fBwadd_wch()\fR function is identical to \fBadd_wch()\fR, but writes the +character to the window specified by \fIwin\fR. These functions advance the +cursor after writing the character. +.sp +.LP +If \fIwch\fR is a spacing complex character, X/Open Curses replaces any +previous character at the specified location with \fIwch\fR (and its +rendition). If \fIwch\fR is a non-spacing complex character, X/Open Curses +preserves all existing characters at the specified location and adds the +non-spacing characters of \fIwch\fR to the spacing complex character. It +ignores the rendition associated with \fIwch\fR. +.sp +.LP +Characters that do not fit on the end of the current line are wrapped to the +beginning of the next line unless the current line is the last line of the +window and scrolling is disabled. In that situation, X/Open Curses discards +characters which extend beyond the end of the line. +.sp +.LP +When \fIwch\fR is a backspace, carriage return, newline, or tab, X/Open Curses +moves the cursor appropriately as described in the \fBcurses\fR(3XCURSES) man +page. Each tab character moves the cursor to the next tab stop. By default, tab +stops occur every eight columns. When \fIwch\fR is a control character other +than a backspace, carriage return, newline, or tab, it is written using +\fB^\fR\fIx\fR notation, where \fIx\fR is a printable character. When X/Open +Curses writes \fIwch\fR to the last character position on a line, it +automatically generates a newline. When \fI wch\fR is written to the last +character position of a scrolling region and \fBscrollok()\fR is enabled, +X/Open Curses scrolls the scrolling region up one line (see +\fBclearok\fR(3XCURSES)). +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 7n +.rt +Is the character/attribute pair (rendition) to be written to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the character is to be written. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the character's position in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the character's position in the window. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattr_off\fR(3XCURSES), \fBbkgrndset\fR(3XCURSES), \fBcurses\fR(3XCURSES), +\fBdoupdate\fR(3XCURSES), \fBin_wch\fR(3XCURSES), \fBins_wch\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBnl\fR(3XCURSES), \fBprintw\fR(3XCURSES), +\fBscrollok\fR(3XCURSES), \fBscrl\fR(3XCURSES), \fBsetscrreg\fR(3XCURSES), +\fBterminfo\fR(4), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/add_wchnstr.3xcurses b/usr/src/man/man3xcurses/add_wchnstr.3xcurses new file mode 100644 index 0000000000..5043f6f912 --- /dev/null +++ b/usr/src/man/man3xcurses/add_wchnstr.3xcurses @@ -0,0 +1,177 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH add_wchnstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +add_wchnstr, add_wchstr, mvadd_wchnstr, mvadd_wchstr, mvwadd_wchnstr, +mvwadd_wchstr, wadd_wchnstr, wadd_wchstr \- copy a string of complex characters +(with renditions) to a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +\fBint\fR \fBadd_wchnstr\fR(\fBconst cchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBadd_wchstr\fR(\fBconst cchar_t *\fR\fIwchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvadd_wchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvadd_wchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwadd_wchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, + \fBconst cchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwadd_wchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwadd_wchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwadd_wchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBadd_wchstr()\fR function copies the string of \fBcchar_t\fR characters +to the \fBstdscr\fR window at the current cursor position. The +\fBmvadd_wchstr()\fR and \fBmvwadd_wchstr()\fR functions copy the string to +the starting position indicated by the \fIx\fR (column) and \fIy\fR (row) +parameters (the former to the \fBstdscr\fR window; the latter to window +\fIwin\fR). The \fBwadd_wchstr()\fR is identical to \fBadd_wchstr()\fR, but +writes to the window specified by \fIwin\fR. +.sp +.LP +The \fBadd_wchnstr()\fR, \fBwadd_wchnstr()\fR, \fBmvadd_wchnstr()\fR, and +\fBmvwadd_wchnstr()\fR functions write \fIn\fR characters to the window, or as +many as will fit on the line. If \fIn\fR is less than 0, the entire string is +written, or as much of it as fits on the line. The former two functions place +the string at the current cursor position; the latter two commands use the +position specified by the \fIx\fR and \fIy\fR parameters. +.sp +.LP +These functions differ from the \fBaddwstr\fR(3XCURSES) set of functions in two +important respects. First, these functions do \fInot\fR advance the cursor +after writing the string to the window. Second, the current window rendition +(that is, the combination of attributes and color pair) is not combined with +the character; only those attributes that are already part of the +\fBcchar_t\fR character are used. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwchstr\fR\fR +.ad +.RS 10n +.rt +Is a pointer to the \fBcchar_t\fR string to be copied to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 10n +.rt +Is the maximum number of characters to be copied from \fIwchstr\fR. If +\fIn\fR is less than 0, the entire string is written or as much of it as fits +on the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 10n +.rt +Is the y (row) coordinate of the starting position of \fIwchstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 10n +.rt +Is the x (column) coordinate of the starting position of \fIwchstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 10n +.rt +Is a pointer to the window to which the string is to be copied. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddnwstr\fR(3XCURSES), \fBadd_wch\fR(3XCURSES), \fBattr_off\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/addch.3xcurses b/usr/src/man/man3xcurses/addch.3xcurses new file mode 100644 index 0000000000..f0781bac43 --- /dev/null +++ b/usr/src/man/man3xcurses/addch.3xcurses @@ -0,0 +1,162 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH addch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +addch, mvaddch, mvwaddch, waddch \- add a character (with rendition) to a +window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +\fBint\fR \fBaddch\fR(\fBconst chtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvaddch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwaddch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwaddch\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype\fR \fIch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBaddch()\fR function writes a character to the \fBstdscr\fR window at +the current cursor position. The \fBmvaddch()\fR and \fBmvwaddch()\fR +functions write the character to the position indicated by the \fIx\fR +(column) and \fIy\fR (row) parameters. The \fBmvaddch()\fR function writes the +character to the \fBstdscr\fR window, while \fBmvwaddch()\fR writes the +character to the window specified by \fIwin\fR. The \fBwaddch()\fR function is +identical to \fBaddch()\fR, but writes the character to the window specified +by \fIwin\fR. +.sp +.LP +These functions advance the cursor after writing the character. Characters that +do not fit on the end of the current line are wrapped to the beginning of the +next line unless the current line is the last line of the window and scrolling +is disabled. In that situation, characters which extend beyond the end of the +line are discarded. +.sp +.LP +When \fIch\fR is a backspace, carriage return, newline, or tab, X/Open Curses +moves the cursor appropriately. Each tab character moves the cursor to the next +tab stop. By default, tab stops occur every eight columns. When \fIch\fR is a +control character other than backspace, carriage return, newline, or tab, it +is written using \fB^\fR\fIx\fR notation, where \fIx\fR is a printable +character. When X/Open Curses writes \fIch\fR to the last character position +on a line, it automatically generates a newline. When \fIch\fR is written to +the last character position of a scrolling region and \fBscrollok()\fR is +enabled, X/Open Curses scrolls the scrolling region up one line (see +\fBclearok\fR(3XCURSES)). +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwchstr\fR\fR +.ad +.RS 10n +.rt +Is a pointer to the \fBcchar_t\fR string to be copied to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 10n +.rt +Is the maximum number of characters to be copied from \fIwchstr\fR. If +\fIn\fR is less than 0, the entire string is written or as much of it as fits +on the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 10n +.rt +Is the y (row) coordinate of the starting position of \fIwchstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 10n +.rt +Is the x (column) coordinate of the starting position of \fIwchstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 10n +.rt +Is a pointer to the window to which the string is to be copied. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattroff\fR(3XCURSES), \fBbkgdset\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), +\fBinch\fR(3XCURSES), \fBinsch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBnl\fR(3XCURSES), \fBprintw\fR(3XCURSES), \fBscrollok\fR(3XCURSES), +\fBscrl\fR(3XCURSES), \fBterminfo\fR(4), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/addchstr.3xcurses b/usr/src/man/man3xcurses/addchstr.3xcurses new file mode 100644 index 0000000000..a29de01cbc --- /dev/null +++ b/usr/src/man/man3xcurses/addchstr.3xcurses @@ -0,0 +1,174 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH addchstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +addchstr, addchnstr, mvaddchstr, mvaddchnstr, mvwaddchnstr, mvwaddchstr, +waddchstr, waddchnstr \- copy a character string (with renditions) to a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +\fBint\fR \fBaddchstr\fR(\fBconst chtype *\fR\fIchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBaddchnstr\fR(\fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvaddchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvaddchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwaddchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwaddchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst chtype *\fR\fIchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwaddchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype *\fR\fIchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwaddchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBaddchstr()\fR function copies the \fBchtype\fR character string to the +\fBstdscr\fR window at the current cursor position. The \fBmvaddchstr()\fR and +\fBmvwaddchstr()\fR functions copy the character string to the starting +position indicated by the \fIx\fR (column) and \fIy\fR (row) parameters (the +former to the \fBstdscr\fR window; the latter to window \fIwin\fR). The +\fBwaddchstr()\fR is identical to \fBaddchstr()\fR, but writes to the window +specified by \fIwin\fR. +.sp +.LP +The \fBaddchnstr()\fR, \fBwaddchnstr()\fR, \fBmvaddchnstr()\fR, and +\fBmvwaddchnstr()\fR functions write \fIn\fR characters to the window, or as +many as will fit on the line. If \fIn\fR is less than 0, the entire string is +written, or as much of it as fits on the line. The former two functions place +the string at the current cursor position; the latter two commands use the +position specified by the \fIx\fR and \fIy\fR parameters. +.sp +.LP +These functions differ from the \fBaddstr\fR(3XCURSES) set of functions in two +important respects. First, these functions do \fInot\fR advance the cursor +after writing the string to the window. Second, the current window rendition is +not combined with the character; only the attributes that are already part of +the \fBchtype\fR character are used. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIchstr\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the \fBchtype\fR string to be copied to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 9n +.rt +Is the maximum number of characters to be copied from \fIchstr\fR. If \fIn\fR +is less than 0, the entire string is written or as much of it as fits on the +line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 9n +.rt +Is the y (row) coordinate of the starting position of \fIchstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 9n +.rt +Is the x (column) coordinate of the starting position of \fIchstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window to which the string is to be copied. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBaddnstr\fR(3XCURSES), \fBattroff\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/addnstr.3xcurses b/usr/src/man/man3xcurses/addnstr.3xcurses new file mode 100644 index 0000000000..d2e587970d --- /dev/null +++ b/usr/src/man/man3xcurses/addnstr.3xcurses @@ -0,0 +1,179 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH addnstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +addnstr, addstr, mvaddnstr, mvaddstr, mvwaddnstr, mvwaddstr, waddnstr, waddstr +\- add a multi-byte character string (without rendition) to a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +\fBint\fR \fBaddnstr\fR(\fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBaddstr\fR(\fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvaddnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvaddstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwaddnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwaddstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwaddstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwaddnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBaddstr()\fR function writes a null-terminated string of multi-byte +characters to the \fBstdscr\fR window at the current cursor position. The +\fBwaddstr()\fR function performs an identical action, but writes the +character to the window specified by \fIwin\fR. The \fBmvaddstr()\fR and +\fBmvwaddstr()\fR functions write the string to the position indicated by the +\fIx\fR (column) and \fIy\fR (row) parameters (the former to the \fBstdscr\fR +window; the latter to window \fIwin\fR). +.sp +.LP +The \fBaddnstr()\fR, \fBwaddnstr()\fR, \fBmvaddnstr()\fR, and +\fBmvwaddnstr()\fR functions are similar but write at most \fIn\fR characters +to the window. If \fIn\fR is less than 0, the entire string is written. +.sp +.LP +All of these functions advance the cursor after writing the string. +.sp +.LP +These functions are functionally equivalent to calling the corresponding +function from the \fBaddch\fR(3XCURSES) set of functions once for each +character in the string. Refer to the \fBcurses\fR(3XCURSES) man page for a +complete description of special character handling and of the interaction +between the window rendition (or background character and rendition) and the +character written. +.sp +.LP +Note that these functions differ from the \fBaddchstr()\fR set of functions in +that the \fBaddchstr\fR(3XCURSES) functions copy the string as is (without +combining each character with the window rendition or the background character +and rendition. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIstr\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the character string that is to be written to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +Is the maximum number of characters to be copied from \fIstr\fR. If \fIn\fR is +less than 0, the entire string is written or as much of it as fits on the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the starting position of \fIstr\fR in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the starting position of \fIstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the string is to be written. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBaddchstr\fR(3XCURSES), \fBcurses\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/addnwstr.3xcurses b/usr/src/man/man3xcurses/addnwstr.3xcurses new file mode 100644 index 0000000000..2c7ccdaa7e --- /dev/null +++ b/usr/src/man/man3xcurses/addnwstr.3xcurses @@ -0,0 +1,181 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH addnwstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +addnwstr, addwstr, mvaddnwstr, mvaddwstr, mvwaddnwstr, mvwaddwstr, waddnwstr, +waddwstr \- add a wide-character string to a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR ... ] + +#include <curses.h> + +\fBint\fR \fBaddnwstr\fR(\fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBaddwstr\fR(\fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvaddnwstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvaddwstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwaddnwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwaddwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwaddnwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwaddwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBaddwstr()\fR function writes a null-terminated wide-character string to +the \fBstdscr\fR window at the current cursor position. The \fBwaddwstr()\fR +function performs an identical action, but writes the string to the window +specified by \fIwin\fR. The \fBmvaddwstr()\fR and \fBmvwaddwstr()\fR functions +write the string to the position indicated by the \fIx\fR (column) and \fIy\fR +(row) parameters (the former to the \fBstdscr\fR window; the latter to window +\fIwin\fR). +.sp +.LP +The \fBaddnwstr()\fR, \fBwaddnwstr()\fR, \fBmvaddnwstr()\fR, and +\fBmvwaddnwstr()\fR functions write at most \fIn\fR characters to the window. +If \fIn\fR is less than 0, the entire string is written. The former two +functions place the characters at the current cursor position; the latter two +commands use the position specified by the \fIx\fR and \fIy\fR parameters. +.sp +.LP +All of these functions advance the cursor after writing the string. +.sp +.LP +These functions are functionally equivalent to building a \fBcchar_t\fR from +the \fBwchar_t\fR and the window rendition (or background character and +rendition) and calling the \fBwadd_wch\fR(3XCURSES) function once for each +\fBwchar_t\fR in the string. Refer to the \fBcurses\fR(3XCURSES) man page for +a complete description of special character handling and of the interaction +between the window rendition (or background character and rendition) and the +character written. +.sp +.LP +Note that these functions differ from the \fBadd_wchnstr\fR(3XCURSES) set of +functions in that the latter copy the string as is (without combining each +character with the foreground and background attributes of the window). +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwstr\fR\fR +.ad +.RS 8n +.rt +Is a pointer to the wide-character string that is to be written to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 8n +.rt +Is the maximum number of characters to be copied from \fIwstr\fR. If \fIn\fR is +less than 0, the entire string is written or as much of it as fits on the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 8n +.rt +Is the y (row) coordinate of the starting position of \fIwstr\fR in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 8n +.rt +Is the x (column) coordinate of the starting position of \fIwstr\fR in the +window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 8n +.rt +Is a pointer to the window in which the string is to be written. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBadd_wchnstr\fR(3XCURSES), \fBcurses\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/attr_get.3xcurses b/usr/src/man/man3xcurses/attr_get.3xcurses new file mode 100644 index 0000000000..8d7a88c9e0 --- /dev/null +++ b/usr/src/man/man3xcurses/attr_get.3xcurses @@ -0,0 +1,176 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH attr_get 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +attr_get, attr_off, attr_on, attr_set, color_set, wattr_get, wattr_off, +wattr_on, wattr_set, wcolor_set \- control window attributes +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBattr_get\fR(\fBattr_t *\fR\fIattrs\fR, \fBshort *\fR\fIcolor\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBattr_off\fR(\fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBattr_on\fR(\fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBattr_set\fR(\fBattr_t\fR \fIattrs\fR, \fBshort\fR \fIcolor\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBcolor_set\fR(\fBshort *\fR\fIcolor\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBwattr_get\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBshort *\fR\fIcolor\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBwattr_off\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBwattr_on\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBwattr_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBattr_t\fR \fIattrs\fR, \fBshort\fR \fIcolor\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBwcolor_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBshort\fR \fIcolor\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBattr_get()\fR function retrieves the current rendition of \fIstdscr\fR. +The \fBwattr_get()\fR function retrieves the current rendition of window +\fIwin\fR. If \fIattrs\fR or \fIcolor\fR is a null pointer, no information is +retrieved. +.sp +.LP +The \fBattr_off()\fR and \fBattr_on()\fR functions unset and set, +respectively, the specified window attributes of \fBstdscr\fR. These functions +only affect the attributes specified; attributes that existed before the call +are retained. +.sp +.LP +The \fBwattr_off()\fR and \fBwattr_on()\fR functions unset or set the +specified attributes for window \fIwin\fR. +.sp +.LP +The \fBattr_set()\fR and \fBwattr_set()\fR functions change the rendition of +\fBstdscr\fR and \fIwin\fR; the old values are not retained. +.sp +.LP +The \fBcolor_set()\fR and \fBwcolor_set()\fR functions set the window color of +\fBstdscr\fR and \fIwin\fR to \fIcolor\fR. +.sp +.LP +The attributes and color pairs that can be used are specified in the +\fBAttributes, Color Pairs, and Renditions\fR section of the +\fBcurses\fR(3XCURSES) man page. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIattrs\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the foreground window attributes to be set or unset. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcolor\fR\fR +.ad +.RS 9n +.rt +Is a pointer to a color pair number . +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIopts\fR\fR +.ad +.RS 9n +.rt +Is reserved for future use. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window in which attribute changes are to be made. +.RE + +.SH RETURN VALUES +.sp +.LP +These functions always return \fBOK\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBaddnwstr\fR(3XCURSES), \fBattroff\fR(3XCURSES), +\fBbkgrndset\fR(3XCURSES), \fBcurses\fR(3XCURSES), \fBinit_color\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBstart_color\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/attroff.3xcurses b/usr/src/man/man3xcurses/attroff.3xcurses new file mode 100644 index 0000000000..2cf6cd5d64 --- /dev/null +++ b/usr/src/man/man3xcurses/attroff.3xcurses @@ -0,0 +1,142 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH attroff 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +attroff, attron, attrset, wattroff, wattron, wattrset \- change foreground +window attributes +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBattroff\fR(\fBint\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBattron\fR(\fBint\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBattrset\fR(\fBint\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBwattroff\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBwattron\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBwattrset\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIattrs\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBattroff()\fR and \fBattron()\fR functions unset and set, respectively, +the specified window attributes of \fBstdscr\fR. These functions only affect +the attributes specified; attributes that existed before the call are retained. +The \fBwattroff()\fR and \fBwattron()\fR functions unset or set the specified +attributes for window \fIwin\fR. +.sp +.LP +The \fBattrset()\fR and \fBwattrset()\fR functions change the specified window +renditions of \fBstdscr\fR and \fIwin\fR to new values; the old values are not +retained. +.sp +.LP +The attributes that can be used are specified in the \fBAttributes, Color +Pairs, and Renditions\fR section of the \fBcurses\fR(3XCURSES) man page. +.sp +.LP +Here is an example that prints some text using the current window rendition, +adds underlining, changes the attributes, prints more text, then changes the +attributes back. +.sp +.in +2 +.nf +printw("This word is"); +attron(A_UNDERLINE); +printw("underlined."); +attroff(A_NORMAL); +printw("This is back to normal text.\en"); +refresh(\|); +.fi +.in -2 + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIattrs\fR\fR +.ad +.RS 9n +.rt +are the foreground window attributes to be set or unset. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window in which attribute changes are to be made. +.RE + +.SH RETURN VALUES +.sp +.LP +These functions always return \fBOK\fR or 1. +.SH ERRORS +.sp +.LP +None. +.SH USAGE +.sp +.LP +All of these functions may be macros. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBaddnstr\fR(3XCURSES), \fBattr_get\fR(3XCURSES), +\fBbkgdset\fR(3XCURSES), \fBcurses\fR(3XCURSES), \fBinit_color\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBstart_color\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/baudrate.3xcurses b/usr/src/man/man3xcurses/baudrate.3xcurses new file mode 100644 index 0000000000..091ba98144 --- /dev/null +++ b/usr/src/man/man3xcurses/baudrate.3xcurses @@ -0,0 +1,57 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH baudrate 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +baudrate \- return terminal baud rate +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBbaudrate\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBbaudrate()\fR function returns the terminal's data communication line +and output speed in bits per second (for example, 9600). +.SH RETURN VALUES +.sp +.LP +The \fBbaudrate()\fR function returns the output speed of the terminal. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/beep.3xcurses b/usr/src/man/man3xcurses/beep.3xcurses new file mode 100644 index 0000000000..0dcb4ce026 --- /dev/null +++ b/usr/src/man/man3xcurses/beep.3xcurses @@ -0,0 +1,68 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH beep 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +beep, flash \- activate audio-visual alarm +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBbeep\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBflash\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBbeep()\fR and \fBflash()\fR functions produce an audio and visual alarm +on the terminal, respectively. If the terminal has the capability, +\fBbeep()\fR sounds a bell or beep and \fBflash()\fR flashes the screen. One +alarm is substituted for another if the terminal does not support the +capability called (see \fBterminfo\fR(4) \fBbel\fR and \fBflash\fR +capabilities). For example, a call to \fBbeep()\fR for a terminal without that +capability results in a flash. +.SH RETURN VALUES +.sp +.LP +These functions always return \fBOK\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBterminfo\fR(4), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/bkgd.3xcurses b/usr/src/man/man3xcurses/bkgd.3xcurses new file mode 100644 index 0000000000..70eacab8da --- /dev/null +++ b/usr/src/man/man3xcurses/bkgd.3xcurses @@ -0,0 +1,147 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH bkgd 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +bkgd, bkgdset, getbkgd, wbkgd, wbkgdset \- set or get the background character +(and rendition) of window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBbkgd\fR(\fBchtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBbkgdset\fR(\fBchtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBchtype\fR \fBgetbkgd\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBwbkgd\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBwbkgdset\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBbkgdset()\fR and \fBwbkgdset()\fR functions turn off the previous +background attributes, logical OR the requested attributes into the window +rendition, and set the background property of the current or specified window +based on the information in \fIch\fR. If \fIch\fR refers to a multi-column +character, the results are undefined. +.sp +.LP +The \fBbkgd()\fR and \fBwbkgd()\fR functions turn off the previous background +attributes, logical OR the requested attributes into the window rendition, and +set the background property of the current or specified window and then apply +this setting to every character position in that window: +.RS +4 +.TP +.ie t \(bu +.el o +The rendition of every character on the screen is changed to the new window +rendition. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Wherever the former background character appears, it is changed to the new +background character. +.RE +.sp +.LP +The \fBgetbkgd()\fR function extracts the specified window's background +character and rendition. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 7n +.rt +Is the background character to be set. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the background character is to be set. +.RE + +.SH RETURN VALUES +.sp +.LP +Upon successful completion, the \fBbkgd()\fR and \fBwbkgd()\fR functions return +\fBOK\fR. Otherwise, they return \fBERR\fR. +.sp +.LP +The \fBbkgdset()\fR and \fBwbkgdset()\fR functions do not return a value. +.sp +.LP +Upon successful completion, the \fBgetbkgd()\fR function returns the specified +window's background character and rendition. Otherwise, it returns +\fB(chtype)\fR\fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +These functions are only guaranteed to operate reliably on character sets in +which each character fits into a single byte, whose attributes can be expressed +using only constants with the A_ prefix. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBaddchstr\fR(3XCURSES), \fBattroff\fR(3XCURSES), +\fBbkgrnd\fR(3XCURSES), \fBclear\fR(3XCURSES), \fBclrtoeol\fR(3XCURSES), +\fBclrtobot\fR(3XCURSES), \fBerase\fR(3XCURSES), \fBinch\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBmvprintw\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/bkgrnd.3xcurses b/usr/src/man/man3xcurses/bkgrnd.3xcurses new file mode 100644 index 0000000000..12e7e475a4 --- /dev/null +++ b/usr/src/man/man3xcurses/bkgrnd.3xcurses @@ -0,0 +1,148 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH bkgrnd 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +bkgrnd, bkgrndset, getbkgrnd, wbkgrnd, wbkgrndset, wgetbkgrnd \- set or get the +background character (and rendition) of window using a complex character +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBbkgrnd\fR(\fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBbkgrndset\fR(\fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBgetbkgrnd\fR(\fBcchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwbkgrnd\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBwbkgrndset\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwgetbkgrnd\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBbkgrndset()\fR and \fBwbkgrndset()\fR functions turn off the previous +background attributes, logical OR the requested attributes into the window +rendition, and set the background property of the current or specified window +based on the information in \fIwch\fR. +.sp +.LP +The \fBbkgrnd()\fR and \fBwbkgrnd()\fR functions turn off the previous +background attributes, logical OR the requested attributes into the window +rendition, and set the background property of the current or specified window +and then apply this setting to every character position in that window: +.RS +4 +.TP +.ie t \(bu +.el o +The rendition of every character on the screen is changed to the new window +rendition. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Wherever the former background character appears, it is changed to the new +background character. +.RE +.sp +.LP +If \fIwch\fR refers to a non-spacing complex character for \fBbkgrnd()\fR, +\fBbkgrndset()\fR, \fBwbkgrnd()\fR, and \fBwbkgrndset()\fR, then \fIwch\fR is +added to the existing spacing complex character that is the background +character. If \fIwch\fR refers to a multi-column character, the results are +unspecified. +.sp +.LP +The \fBgetbkgrnd()\fR and \fBwgetbkgrnd()\fR functions store, into the area +pointed to buy \fIwch\fR, the window's background character and rendition. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the complex background character to be set. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the complex background character is to be +set. +.RE + +.SH RETURN VALUES +.sp +.LP +The \fBbkgrndset()\fR and \fBwbkgrndset()\fR functions do not return a value. +.sp +.LP +Upon successful completion, the other functions return \fBOK\fR. Otherwise, +they return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBadd_wchnstr\fR(3XCURSES), \fBaddch\fR(3XCURSES), +\fBaddchstr\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBbkgd\fR(3XCURSES), +\fBclear\fR(3XCURSES), \fBclrtoeol\fR(3XCURSES), \fBclrtobot\fR(3XCURSES), +\fBerase\fR(3XCURSES), \fBinch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBmvprintw\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/border.3xcurses b/usr/src/man/man3xcurses/border.3xcurses new file mode 100644 index 0000000000..193c2a2090 --- /dev/null +++ b/usr/src/man/man3xcurses/border.3xcurses @@ -0,0 +1,247 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH border 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +border, box, wborder \- add a single-byte border to a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBborder\fR(\fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR, \fBchtype\fR \fIbs\fR, \fBchtype\fR \fItl\fR, + \fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR, \fBchtype\fR \fIbr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwborder\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIls\fR, \fBchtype\fR \fIrs\fR, \fBchtype\fR \fIts\fR, \fBchtype\fR \fIbs\fR, + \fBchtype\fR \fItl\fR,\fBchtype\fR \fItr\fR, \fBchtype\fR \fIbl\fR, \fBchtype\fR \fIbr\fR); +.fi + +.LP +.nf +\fBint\fR \fBbox\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIverch\fR, \fBchtype\fR \fIhorch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBborder()\fR and \fBwborder()\fR functions draw a border around the +specified window. All parameters must be single-byte characters whose +rendition can be expressed using only constants beginning with \fBACS_\fR. A +parameter with the value of 0 is replaced by the default value. +.sp + +.sp +.TS +tab() box; +cw(1.83i) cw(1.83i) cw(1.83i) +cw(1.83i) cw(1.83i) cw(1.83i) +. +Constant Values for Borders +_ +ParameterDefault ConstantDefault Character +_ +\fIverch \fR\fBACS_VLINE\fR| +\fIhorch \fR\fBACS_HLINE\fR- +\fBls\fR\fBACS_VLINE\fR| +\fIrs\fR\fBACS_VLINE\fR| +\fIts\fR\fBACS_HLINE\fR- +\fIbs\fR\fBACS_HLINE\fR- +\fIbl\fR\fBACS_BLCORNER\fR+ +\fIbr\fR\fBACS_BRCORNER\fR+ +\fItl\fR\fBACS_ULCORNER\fR+ +\fBtr\fR\fBACS_URCORNER\fR+ +.TE + +.sp +.LP +The call +.sp +.in +2 +.nf +\fBbox(\fR\fIwin\fR, +\fIverch\fR, \fIhorch\fR) +.fi +.in -2 + +.sp +.LP +is a short form for +.sp +.in +2 +.nf +\fBwborder(\fR\fIwin\fR, +\fIverch\fR, \fIverch\fR, +\fIhorch\fR, \fIhorch\fR, 0, 0, 0, +0) +.fi +.in -2 + +.sp +.LP +When the window is boxed, the bottom and top rows and right and left columns +overwrite existing text. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIls\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the left side of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIrs\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the right side of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIts\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbs\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the bottom of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fItl\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top-left corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fItr\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top-right corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbl\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the bottom-left corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbr\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the bottom-right corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is the pointer to the window in which the border or box is to be drawn. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIverch\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the left and right columns of the box. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIhorch\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top and bottom rows of the box. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBaddch\fR(3XCURSES), \fBattr_get\fR(3XCURSES), +\fBattroff\fR(3XCURSES), \fBborder_set\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/border_set.3xcurses b/usr/src/man/man3xcurses/border_set.3xcurses new file mode 100644 index 0000000000..529250023e --- /dev/null +++ b/usr/src/man/man3xcurses/border_set.3xcurses @@ -0,0 +1,253 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH border_set 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +border_set, box_set, wborder_set \- use complex characters (and renditions) to +draw borders +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBborder_set\fR(\fBconst cchar_t *\fR\fIls\fR, \fBconst cchar_t *\fR\fIrs\fR, \fBconst cchar_t *\fR\fIts\fR, + \fBconst cchar_t *\fR\fIbs\fR, \fBconst cchar_t *\fR\fItl\fR, \fBconst cchar_t *\fR\fItr\fR, + \fBconst cchar_t *\fR\fIbl\fR,\fBconst cchar_t *\fR\fIbr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwborder_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIls\fR, \fBconst cchar_t *\fR\fIrs\fR, + \fBconst cchar_t *\fR\fIts\fR,\fBconst cchar_t *\fR\fIbs\fR, \fBconst cchar_t *\fR\fItl\fR, + \fBconst cchar_t *\fR\fItr\fR, \fBconst cchar_t *\fR\fIbl\fR,\fBconst cchar_t *\fR\fIbr\fR); +.fi + +.LP +.nf +\fBint\fR \fBbox_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIverch\fR, \fBconst cchar_t *\fR\fIhorch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBborder_set()\fR and \fBwborder_set()\fR functions draw a border around +the specified window. All parameters must be spacing complex characters with +renditions. A parameter which is a null pointer is replaced by the default +character. +.sp +.LP +\fBConstant Values for Borders\fR +.sp + +.sp +.TS +tab() box; +cw(1.83i) cw(1.83i) cw(1.83i) +cw(1.83i) cw(1.83i) cw(1.83i) +. +Constant Values for Borders +_ +ParameterDefault ConstantDefault Character +_ +\fIverch \fR\fBWACS_VLINE\fR\fB|\fR +\fIhorch \fR\fBWACS_HLINE\fR\fB-\fR +\fBls\fR\fBWACS_VLINE\fR\fB|\fR +\fIrs\fR\fBWACS_VLINE\fR\fB|\fR +\fIts\fR\fBWACS_HLINE\fR\fB-\fR +\fIbs\fR\fBWACS_HLINE\fR\fB-\fR +\fIbl\fR\fBWACS_BLCORNER\fR\fB+\fR +\fIbr\fR\fBWACS_BRCORNER\fR\fB+\fR +\fItl\fR\fBWACS_ULCORNER\fR\fB+\fR +\fBtr\fR\fBWACS_URCORNER\fR\fB+\fR +.TE + +.sp +.LP +The call +.sp +.in +2 +.nf +\fBbox_set(\fR\fIwin\fR, +\fIverch\fR, \fIhorch\fR) +.fi +.in -2 + +.sp +.LP +is a short form for +.sp +.in +2 +.nf +\fBwborder(\fR\fIwin\fR, +\fIverch\fR, \fIverch\fR, +\fIhorch\fR, \fIhorch\fR, NULL, +NULL, NULL, NULL) +.fi +.in -2 + +.sp +.LP +When the window is boxed, the bottom and top rows and right and left columns +are unavailable for text. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIls\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the left side of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIrs\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the right side of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIts\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbs\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the bottom of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fItl\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top-left corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fItr\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top-right corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbl\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the bottom-left corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbr\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the bottom-right corner of the border. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is the pointer to the window in which the border or box is to be drawn. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIverch\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the left and right columns of the box. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIhorch\fR\fR +.ad +.RS 9n +.rt +Is the character and rendition used for the top and bottom rows of the box. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBaddch\fR(3XCURSES), \fBattr_get\fR(3XCURSES), +\fBattroff\fR(3XCURSES), \fBborder\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/can_change_color.3xcurses b/usr/src/man/man3xcurses/can_change_color.3xcurses new file mode 100644 index 0000000000..2d97e8acdf --- /dev/null +++ b/usr/src/man/man3xcurses/can_change_color.3xcurses @@ -0,0 +1,311 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH can_change_color 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +can_change_color, color_content, COLOR_PAIR, has_colors, init_color, init_pair, +pair_content, PAIR_NUMBER, start_color, COLOR_PAIRS, COLORS \- manipulate color +information +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBbool\fR \fBcan_change_color\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBcolor_content\fR(\fBshort\fR \fIcolor\fR, \fBshort *\fR\fIred\fR, \fBshort *\fR\fIgreen\fR, \fBshort *\fR\fIblue\fR); +.fi + +.LP +.nf +\fBint\fR \fBCOLOR_PAIR\fR(\fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBbool\fR \fBhas_colors\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBinit_color\fR(\fBshort\fR \fIcolor\fR, \fBshort\fR \fIred\fR, \fBshort\fR \fIgreen\fR, \fBshort\fR \fIblue\fR); +.fi + +.LP +.nf +\fBint\fR \fBinit_pair\fR(\fBshort\fR \fIpair\fR, \fBshort\fR \fIf\fR, \fBshort\fR \fIb\fR); +.fi + +.LP +.nf +\fBint\fR \fBpair_content\fR(\fBshort\fR \fIpair\fR, \fBshort *\fR\fIf\fR, \fBshort *\fR\fIb\fR); +.fi + +.LP +.nf +\fBint\fR \fBPAIR_NUMBER\fR(\fBint\fR \fIvalue\fR); +.fi + +.LP +.nf +\fBint\fR \fBstart_color\fR(\fBvoid\fRextern int COLOR_PAIRS; + +extern int COLORS; +.fi + +.SH DESCRIPTION +.sp +.LP +These functions manipulate color on terminals that support color. +.SS " Querying Capabilities" +.sp +.LP +The \fBhas_colors()\fR function indicates whether the terminal is a color +terminal. The \fBcan_change_color()\fR function indicates whether the terminal +is a color terminal on which colors can be redefined. +.SS "Initialization" +.sp +.LP +The \fBstart_color()\fR function must be called to enable use of colors and +before any color manipulation function is called. The function initializes +eight basic colors (black, red, green, yellow, blue, magenta, cyan, and white) +that can be specified by the color macros (such as \fBCOLOR_BLACK\fR) defined +in <\fBcurses.h\fR>. The initial appearance of these colors is unspecified. +.sp +.LP +The function also initializes two global external variables: +.RS +4 +.TP +.ie t \(bu +.el o +\fBCOLORS\fR defines the number of colors that the terminal supports. See +\fBColor Identification\fR below. If \fBCOLORS\fR is 0, the terminal does not +support redefinition of colors and \fBcan_change_color()\fR will return +\fBFALSE\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +\fBCOLOR_PAIRS\fR defines the maximum number of color-pairs that the terminal +supports. See \fBUser-defined Color Pairs\fR below. +.RE +.sp +.LP +The \fBstart_color()\fR function also restores the colors on the terminal to +terminal-specific initial values. The initial background color is assumed to be +black for all terminals. +.SS "Color Identification" +.sp +.LP +The \fBinit_color()\fR function redefines color number \fIcolor\fR, on +terminals that support the redefinition of colors, to have the red, green, and +blue intensity components specified by \fIred\fR, \fIgreen\fR, and \fIblue\fR, +respectively. Calling \fBinit_color()\fR also changes all occurrences of the +specified color on the screen to the new definition. +.sp +.LP +The \fBcolor_content()\fR function identifies the intensity components of color +number \fIcolor\fR. It stores the red, green, and blue intensity components of +this color in the addresses pointed to by \fIred\fR, \fIgreen\fR, and +\fIblue\fR, respectively. +.sp +.LP +For both functions, the \fIcolor\fR argument must be in the range from 0 to and +including \fBCOLORS\fR\(mi1. Valid intensity value range from 0 (no intensity +component) up to and including 1000 (maximum intensity in that component). +.SS "User-defined Color Pairs" +.sp +.LP +Calling \fBinit_pair()\fR defines or redefines color-pair number \fIpair\fR to +have foreground color \fIf\fR and background color \fIb\fR. Calling +\fBinit_pair()\fR changes any characters that were displayed in the color +pair's old definition to the new definition and refreshes the screen. +.sp +.LP +After defining the color pair, the macro \fBCOLOR_PAIR(\fR\fIn\fR\fB)\fR +returns the value of color pair \fIn\fR. This value is the color attribute as +it would be extracted from a \fBchtype\fR. Controversy, the macro +\fBCOLOR_NUMBER(\fR\fIvalue\fR\fB)\fR returns the color pair number associated +with the color attribute \fIvalue\fR. +.sp +.LP +The \fBpair_content()\fR retrieves the component colors of a color-pair number +\fIpair\fR. It stores the foreground and background color numbers in the +variables pointed to by \fIf\fR and \fIb\fR, respectively. +.sp +.LP +With \fBinit_pair()\fR and \fBpair_content()\fR, the value of \fIpair\fR must +be in a range from 0 to and including \fBCOLOR_PAIRS\fR\(mi1. Valid values for +\fIf\fR and \fIb\fR are the range from 0 to and including \fBCOLORS\fR\(mi1. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIcolor\fR\fR +.ad +.RS 9n +.rt +Is the number of the color for which to provide information (0 to +\fBCOLORS\fR\(mi1). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIred\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the RGB value for the amount of red in \fIcolor\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIgreen\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the RGB value for the amount of green in \fIcolor\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIblue\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the RGB value for the amount of blue in \fIcolor\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 9n +.rt +Is the number of a color pair. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpair\fR\fR +.ad +.RS 9n +.rt +Is the number of the color pair for which to provide information (1 to +\fBCOLOR_PAIRS\fR\(mi1). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIf\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the number of the foreground color (0 to \fBCOLORS\fR\(mi1) in +\fIpair\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIb\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the number of the background color (0 to \fBCOLORS\fR\(mi1) in +\fIpair\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIvalue\fR\fR +.ad +.RS 9n +.rt +Is a color attribute value. +.RE + +.SH RETURN VALUES +.sp +.LP +The \fBhas_colors()\fR function returns \fBTRUE\fR if the terminal can +manipulate colors. Otherwise, it returns \fBFALSE\fR. +.sp +.LP +The \fBcan_change_color()\fR function returns \fBTRUE\fR if the terminal +supports colors and is able to change their definitions. Otherwise, it returns +\fBFALSE\fR. +.sp +.LP +Upon successful completion, the other functions return \fBOK\fR. Otherwise, +they return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +To use these functions, \fBstart_color()\fR must be called, usually right after +\fBinitscr\fR(3XCURSES). +.sp +.LP +The \fBcan_change_color()\fR and \fBhas_colors()\fR functions facilitate +writing terminal-independent applications. For example, a programmer can use +them to decide whether to use color or some other video attribute. +.sp +.LP +On color terminals, a typical value of \fBCOLORS\fR is 8 and the macros such as +\fBCOLOR_BLACK\fR return a value within the range from 0 to and including 7. +However, applications cannot rely on this to be true. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattroff\fR(3XCURSES), \fBdelscreen\fR(3XCURSES), \fBinitscr\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/cbreak.3xcurses b/usr/src/man/man3xcurses/cbreak.3xcurses new file mode 100644 index 0000000000..43533e49d7 --- /dev/null +++ b/usr/src/man/man3xcurses/cbreak.3xcurses @@ -0,0 +1,94 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH cbreak 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +cbreak, nocbreak, noraw, raw \- set input mode controls +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBcbreak\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBnocbreak\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBnoraw\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBraw\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBcbreak()\fR function enables the character input mode. This overrides +any previous call to the \fBraw()\fR function and turns the \fBstty\fR flag +\fBICANON\fR off. +.sp +.LP +The \fBnocbreak()\fR function sets the line canonical mode and turns the +\fBstty\fR flag \fBICANON\fR on without touching the \fBISIG\fR or \fBIXON\fR +flags. +.sp +.LP +The \fBnoraw()\fR function sets the line canonical mode and turns the +\fBstty\fR flags \fBICANON\fR, \fBISIG\fR, and \fBIXON\fR all on. +.sp +.LP +The \fBraw()\fR function sets the character input mode and turns the \fBstty\fR +flags \fBICANON\fR, \fBISIG\fR, and \fBIXON\fR all off. This mode provides +maximum control over input. +.sp +.LP +It is important to remember that the terminal may or may not be in character +mode operation initially. Most interactive programs require \fBcbreak()\fR to +be enabled. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetch\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), \fBnodelay\fR(3XCURSES), +\fBtimeout\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5), \fBtermio\fR(7I) diff --git a/usr/src/man/man3xcurses/chgat.3xcurses b/usr/src/man/man3xcurses/chgat.3xcurses new file mode 100644 index 0000000000..49447727f1 --- /dev/null +++ b/usr/src/man/man3xcurses/chgat.3xcurses @@ -0,0 +1,172 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH chgat 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +chgat, mvchgat, mvwchgat, wchgat \- change the rendition of characters in a +window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBchgat\fR(\fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor\fR, \fBconst void *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvchgat\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor\fR, + \fBconst void *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwchgat\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR, + \fBshort\fR \fIcolor\fR, \fBconst void *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBwchgat\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIn\fR, \fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor\fR, + \fBconst void *\fR\fIopts\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +These functions change the renditions of the next \fIn\fR characters in the +current or specified window (or of the remaining characters on the current or +specified line, if \fIn\fR is \(mi1), beginning at the current or specified +cursor position. The attributes and colors are specified by \fIattr\fR and +\fIcolor\fR as for \fBsetcchar\fR(3XCURSES). +.sp +.LP +These function neither update the cursor nor perform wrapping. +.sp +.LP +A value of \fIn\fR that is greater than the remaining characters on a line is +not an error. +.sp +.LP +The \fIopts\fR argument is reserved for definition in a future release. +Currently, the application must provide a null pointer for \fIopts\fR. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 9n +.rt +Is the number of characters whose rendition is to be changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIattr\fR\fR +.ad +.RS 9n +.rt +Is the set of attributes to be assigned to the characters. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcolor\fR\fR +.ad +.RS 9n +.rt +Is the new color pair to be assigned to the characters. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIopts\fR\fR +.ad +.RS 9n +.rt +Is reserved for future use. Currently, this must be a null pointer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 9n +.rt +Is the y (row) coordinate of the starting position in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 9n +.rt +Is the x (column) coordinate of the starting position in the window. changed in +the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window in which the rendition of characters is to be +changed. +.RE + +.SH RETURN VALUES +.sp +.LP + Upon successful completion, these functions returned \fBOK\fR. Otherwise, they +return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgrnd\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBsetcchar\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/clear.3xcurses b/usr/src/man/man3xcurses/clear.3xcurses new file mode 100644 index 0000000000..6663ae8ecb --- /dev/null +++ b/usr/src/man/man3xcurses/clear.3xcurses @@ -0,0 +1,112 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH clear 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +clear, erase, wclear, werase \- clear a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBclear\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBerase\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwclear\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBwerase\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBclear()\fR and \fBerase()\fR functions clear \fBstdscr\fR, destroying +its previous contents. The \fBwclear()\fR and \fBwerase()\fR functions perform +the same action, but clear the window specified by \fIwin\fR instead of +\fBstdscr\fR. +.sp +.LP +The \fBclear()\fR and \fBwclear()\fR functions also call the \fBclearok()\fR +function. This function clears and redraws the entire screen on the next call +to \fBrefresh\fR(3XCURSES) or \fBwrefresh\fR(3XCURSES) for the window. +.sp +.LP +The current background character (and attributes) is used to clear the screen. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window that is to be cleared. +.RE + +.SH ERRORS +.sp +.ne 2 +.mk +.na +\fB\fBOK\fR\fR +.ad +.RS 7n +.rt +Successful completion. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBERR\fR\fR +.ad +.RS 7n +.rt +An error occurred. +.RE + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgdset\fR(3XCURSES), \fBclearok\fR(3XCURSES), \fBclrtobot\fR(3XCURSES), +\fBclrtoeol\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBrefresh\fR(3XCURSES), \fBwrefresh\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/clearok.3xcurses b/usr/src/man/man3xcurses/clearok.3xcurses new file mode 100644 index 0000000000..c2dbe04f9d --- /dev/null +++ b/usr/src/man/man3xcurses/clearok.3xcurses @@ -0,0 +1,185 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH clearok 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +clearok, idlok, leaveok, scrollok, setscrreg, wsetscrreg \- terminal output +control functions +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBclearok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.LP +.nf +\fBint\fR \fBidlok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.LP +.nf +\fBint\fR \fBleaveok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.LP +.nf +\fBint\fR \fBscrollok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.LP +.nf +\fBint\fR \fBsetscrreg\fR(\fBint\fR \fItop\fR, \fBint\fR \fIbot\fR); +.fi + +.LP +.nf +\fBint\fR \fBwsetscrreg\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fItop\fR, \fBint\fR \fIbot\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +These functions set options that deal with the output within Curses functions. +.sp +.LP +The \fBclearok()\fR function assigns the value of \fIbf\fR to an internal flag +in the specified window that governs clearing of the screen during a refresh. +If, during a refresh operation on the specified window, the flag in +\fIcurscr\fR is \fBTRUE\fR or the flag in the specified window is \fBTRUE\fR, +\fBclearok()\fR clears the screen, redraws it in its entirety, and sets the +flag to \fBFALSE\fR in \fIcurscr\fR and in the specified window. The initial +state is unspecified +.sp +.LP +The \fBidlok()\fR function specifies whether the implementation may use the +hardware insert-line, delete-line, and scroll features of terminals so +equipped. If \fIbf\fR is \fBTRUE\fR, use of these features is enabled. If +\fIbf\fR is \fBFALSE\fR, use of these features is disabled and lines are +instead redrawn as required. The initial state is \fBFALSE\fR. +.sp +.LP +The \fBleaveok()\fR function controls the cursor position after a refresh +operation. If \fIbf\fR is \fBTRUE\fR, refresh operations on the specified +window may leave the terminal's cursor at an arbitrary position. If \fIbf\fR is +\fBFALSE\fR, then at the end of any refresh operation, the terminal's cursor is +positioned at the cursor position contained in the specified window. The +initial state is \fBFALSE\fR. +.sp +.LP +The \fBscrollok()\fR function controls the use of scrolling.If \fIbf\fR is +\fBTRUE\fR, then scrolling is enabled for the specified window. If \fIbf\fR is +\fBFALSE\fR, scrolling is disabled for the specified window. The initial state +is \fBFALSE\fR. +.sp +.LP +The \fBsetscrreg()\fR and \fBwsetscrreg()\fR functions define a software +scrolling region in the current or specified window. The \fItop\fR and +\fIbottom\fR arguments are the line numbers of the first and last line defining +the scrolling region. (Line 0 is the top line of the window.) If this option +and \fBscrollok()\fR are enabled, an attempt to move off the last line of the +margin causes all lines in the scrolling region to scroll one line in the +direction of the first line. Only characters in the window are scrolled. If a +software scrolling region is set and \fBscrollok()\fR is not enabled, an +attempt to move off the last line of the margin does not reposition any lines +in the scrolling region. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to a window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fItop\fR\fR +.ad +.RS 7n +.rt +Is the top line of the scrolling region (top of the window is line 0). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbot\fR\fR +.ad +.RS 7n +.rt +Is the bottom line of the scrolling region (top of the window is line 0). +.RE + +.SH RETURN VALUES +.sp +.LP +Upon successful completion, the \fBsetscrreg()\fR and \fBwsetscrreg()\fR +functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.sp +.LP +The other functions always return \fBOK\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP + The only reason to enable the \fBidlok()\fR feature is to use scrolling to +achieve the visual effect of motion of a partial window, such as for a screen +editor. In other cases, the feature can be visually annoying. +.sp +.LP +The \fBleaveok()\fR option provides greater efficiency for applications that do +not use the cursor. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgdset\fR(3XCURSES), \fBclear\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBscrl\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/clrtobot.3xcurses b/usr/src/man/man3xcurses/clrtobot.3xcurses new file mode 100644 index 0000000000..43d63e32fd --- /dev/null +++ b/usr/src/man/man3xcurses/clrtobot.3xcurses @@ -0,0 +1,84 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH clrtobot 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +clrtobot, wclrtobot \- clear to the end of a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBclrtobot\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwclrtobot\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBclrtobot()\fR function clears all characters in the \fBstdscr\fR window +from the cursor to the end of the window. The \fBwclrtobot()\fR function +performs the same action in the window specified by \fIwin\fR instead of in +\fBstdscr\fR. The current background character (and rendition) is used to clear +the screen. +.sp +.LP +If the clearing action results in clearing only a portion of a multicolumn +character, background characters are displayed in place of the remaining +portion. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window that is to be cleared. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgdset\fR(3XCURSES), \fBclear\fR(3XCURSES), \fBclearok\fR(3XCURSES), +\fBclrtoeol\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/clrtoeol.3xcurses b/usr/src/man/man3xcurses/clrtoeol.3xcurses new file mode 100644 index 0000000000..238b75fa5a --- /dev/null +++ b/usr/src/man/man3xcurses/clrtoeol.3xcurses @@ -0,0 +1,85 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH clrtoeol 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +clrtoeol, wclrtoeol \- clear to the end of a line +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBclrtoeol\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwclrtoeol\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBclrtoeol()\fR function clears the current line from the cursor to the +right margin in the \fBstdscr\fR window. The \fBwclrtoeol()\fR function +performs the same action, but in the window specified by \fIwin\fR instead of +\fBstdscr\fR. The current background character (and rendition) is used to clear +the screen. +.sp +.LP +If the clearing action results in clearing only a portion of a multicolumn +character, background characters are displayed in place of the remaining +portion. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which to clear to the end of the line. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return +\fBFALSE\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgdset\fR(3XCURSES), \fBclear\fR(3XCURSES), \fBclearok\fR(3XCURSES), +\fBclrtobot\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/copywin.3xcurses b/usr/src/man/man3xcurses/copywin.3xcurses new file mode 100644 index 0000000000..f3b7f01555 --- /dev/null +++ b/usr/src/man/man3xcurses/copywin.3xcurses @@ -0,0 +1,173 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH copywin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +copywin \- overlay or overwrite any portion of window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBcopywin\fR(\fBconst WINDOW *\fR\fIsrcwin\fR, \fBWINDOW *\fR\fIdstwin\fR, \fBint\fR \fIsminrow\fR, \fBint\fR \fIsmincol\fR, + \fBint\fR \fIdminrow\fR, \fBint\fR \fIdmincol\fR, \fBint\fR \fIdmaxrow\fR, \fBint\fR \fIdmaxcol\fR, \fBint\fR \fIoverlay\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIsrcwin\fR\fR +.ad +.RS 11n +.rt +Is a pointer to the source window to be copied. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIdstwin\fR\fR +.ad +.RS 11n +.rt +Is a pointer to the destination window to be overlayed or overwritten. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIsminrow\fR\fR +.ad +.RS 11n +.rt +Is the row coordinate of the upper left corner of the rectangular area on the +source window to be copied. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIsmincol\fR\fR +.ad +.RS 11n +.rt +Is the column coordinate of the upper left corner of the rectangular area on +the source window to be copied. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIdminrow\fR\fR +.ad +.RS 11n +.rt +Is the row coordinate of the upper left corner of the rectangular area on the +destination window to be overlayed or overwritten. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIdmincol\fR\fR +.ad +.RS 11n +.rt +Is the column coordinate of the upper left corner of the rectangular area on +destination window to be overlayed or overwritten. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIdmaxrow\fR\fR +.ad +.RS 11n +.rt +Is the row coordinate of the lower right corner of the rectangular area on the +destination window to be overlayed or overwritten. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIdmaxcol\fR\fR +.ad +.RS 11n +.rt +Is the column coordinate of the lower right corner of the rectangular area on +the destination window to be overlayed or overwritten. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIoverlay\fR\fR +.ad +.RS 11n +.rt +Is a \fBTRUE\fR or \fBFALSE\fR value that determines whether the destination +window is overlayed or overwritten. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBcopywin()\fR function provides a finer granularity of control over the +\fBoverlay\fR(3XCURSES) and \fBoverwrite\fR(3XCURSES) functions. As in the +\fBprefresh()\fR function (see \fBnewpad\fR(3XCURSES)), a rectangle is +specified in the destination window, (\fIdminrow\fR, \fIdmincol\fR) and +(\fIdmaxrow\fR, \fIdmaxcol\fR), and the upper-left-corner coordinates of the +source window, (\fIsmincol\fR, \fIsminrow\fR). If \fIoverlay\fR is \fBTRUE\fR, +then copying is non-destructive, as in \fBoverlay()\fR. If \fIoverlay\fR is +\fBFALSE\fR, then copying is destructive, as in \fBoverwrite()\fR. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, the \fBcopywin()\fR function returns \fBOK\fR. +Otherwise, it returns \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBcurses\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewpad\fR(3XCURSES), +\fBoverlay\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/cur_term.3xcurses b/usr/src/man/man3xcurses/cur_term.3xcurses new file mode 100644 index 0000000000..e9cb9b48aa --- /dev/null +++ b/usr/src/man/man3xcurses/cur_term.3xcurses @@ -0,0 +1,50 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH cur_term 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +cur_term \- current terminal information +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR \fB/usr/xpg4/include\fR \fB-L\fR \fB/usr/xpg4/lib\fR \e +\fB-R\fR \fB/usr/xpg4/lib\fR \fB-lcurses\fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +extern TERMINAL *cur_term; +.fi + +.SH DESCRIPTION +.sp +.LP +The external variable \fBcur_term\fR to identifies the record in the +\fBterminfo\fR associated with the terminal currently in use. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBset_curterm\fR(3XCURSES), +\fBtigetflag\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/curs_set.3xcurses b/usr/src/man/man3xcurses/curs_set.3xcurses new file mode 100644 index 0000000000..89ca1c21ba --- /dev/null +++ b/usr/src/man/man3xcurses/curs_set.3xcurses @@ -0,0 +1,72 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH curs_set 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +curs_set \- set visibility of cursor +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBcurs_set\fR(\fBint\fR \fIvisibility\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBcurs_set()\fR function sets the visibility of the cursor to invisible +(0), normal (1), or very visible (2). The exact appearance of normal and very +visible cursors is terminal dependent. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIvisibility\fR\fR +.ad +.RS 14n +.rt +Is a value of 0 (invisible), 1 (normal), or 2 (very visible). +.RE + +.SH RETURN VALUES +.sp +.LP +If the terminal supports the mode specified by the \fIvisibility\fR parameter, +the \fBcurs_set()\fR function returns the previous cursor state. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/curscr.3xcurses b/usr/src/man/man3xcurses/curscr.3xcurses new file mode 100644 index 0000000000..b326612ab7 --- /dev/null +++ b/usr/src/man/man3xcurses/curscr.3xcurses @@ -0,0 +1,51 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH curscr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +curscr \- current window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR \fB/usr/xpg4/include\fR \fB-L\fR \fB/usr/xpg4/lib\fR \e +\fB-R\fR \fB/usr/xpg4/lib\fR \fB-lcurses\fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +extern WINDOW *curscr; +.fi + +.SH DESCRIPTION +.sp +.LP +The external variable \fBcurscr\fR points to an internal data structure. It can +be specified as an argument to certain functions such as +\fBclearok\fR(3XCURSES). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBclearok\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/curses.3xcurses b/usr/src/man/man3xcurses/curses.3xcurses new file mode 100644 index 0000000000..504d121fdf --- /dev/null +++ b/usr/src/man/man3xcurses/curses.3xcurses @@ -0,0 +1,943 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH curses 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +curses \- introduction and overview of X/Open Curses +.SH DESCRIPTION +.sp +.LP +The Curses screen management package conforms fully with Issue 4, Version 2 of +the X/Open Curses specification. It provides a set of internationalized +functions and macros for creating and modifying input and output to a terminal +screen. This includes functions for creating windows, highlighting text, +writing to the screen, reading from user input, and moving the cursor. +.sp +.LP +X/Open Curses is a terminal-independent package, providing a common user +interface to a variety of terminal types. Its portability is facilitated by +the Terminfo database which contains a compiled definition of each terminal +type. By referring to the database information X/Open Curses gains access to +low-level details about individual terminals. +.sp +.LP +X/Open Curses tailors its activities to the terminal type specified by the +\fBTERM\fR environment variable. The \fBTERM\fR environment variable may be +set in the Korn Shell (see \fBksh\fR(1)) by typing: +.sp +.in +2 +.nf +\fBexport TERM=\fR\fIterminal_name\fR +.fi +.in -2 +.sp + +.sp +.LP +To set environment variables using other command line interfaces or shells, see +the \fBenviron\fR(5) manual page. +.sp +.LP +Three additional environment variables are useful, and can be set in the Korn +Shell: +.RS +4 +.TP +1. +If you have an alternate Terminfo database containing terminal types that +are not available in the system default database +\fB/usr/share/lib/terminfo\fR, you can specify the \fBTERMINFO\fR environment +variable to point to this alternate database: +.sp +.in +2 +.nf +\fBexport TERMINFO=\fR\fIpath\fR +.fi +.in -2 +.sp + +This \fIpath\fR specifies the location of the alternate compiled Terminfo +database whose structure consists of directory names 0 to 9 and a to z (which +represent the first letter of the compiled terminal definition file name). +.sp +The alternate database specified by \fBTERMINFO\fR is examined before the +system default database. If the terminal type specified by \fBTERM\fR cannot +be found in either database, the default terminal type \fIdumb\fR is assumed. +.RE +.RS +4 +.TP +2. +To specify a window width smaller than your screen width (for example, in +situations where your communications line is slow), set the \fBCOLUMNS\fR +environment variable to the number of vertical columns you want between the +left and right margins: +.sp +.in +2 +.nf +\fBexport COLUMNS=\fR\fInumber\fR +.fi +.in -2 +.sp + +The \fInumber\fR of columns may be set to a number smaller than the screen +size; however, if set larger than the screen or window width, the results are +undefined. +.sp +The value set using this environment variable takes precedence over the value +normally used for the terminal. +.RE +.RS +4 +.TP +3. +To specify a window height smaller than your current screen height (for +example, in situations where your communications line is slow), override the +\fBLINES\fR environment variable by setting it to a smaller number of +horizontal lines: +.sp +.in +2 +.nf +\fBexport LINES=\fR\fInumber\fR +.fi +.in -2 +.sp + +The \fInumber\fR of lines may be set to a number smaller than the screen +height; however, if set larger than the screen or window height, the results +are undefined. +.sp +The value set using this environment variable takes precedence over the value +normally used for the terminal. +.RE +.SS "Data Types" +.sp +.LP +X/Open Curses defines the following data types: +.sp +.ne 2 +.mk +.na +\fB\fBattr_t\fR\fR +.ad +.RS 12n +.rt +An integral type that holds an OR-ed set of attributes. The attributes +acceptable are those which begin with the \fBWA_\fR prefix . +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBbool\fR\fR +.ad +.RS 12n +.rt +Boolean data type. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBcchar_t\fR\fR +.ad +.RS 12n +.rt +A type that refers to a string consisting of a spacing wide character, up to 5 +non-spacing wide characters, and zero or more attributes of any type. See +Attributes, Color Pairs, and Renditions. A null \fBcchar_t\fR object terminates +arrays of \fBcchar_t\fR objects. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBchtype\fR\fR +.ad +.RS 12n +.rt +An integral type whose values are formed by OR-ing an \fB"unsigned char"\fR +with a color pair. and with zero or more attributes. The attributes acceptable +are those which begin with the \fBA_\fR prefix and \fBCOLOR_PAIR\fR(3XCURSES) +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBSCREEN\fR\fR +.ad +.RS 12n +.rt +An opaque data type associated with a terminal's display screen. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBTERMINAL\fR\fR +.ad +.RS 12n +.rt +An opaque data type associated with a terminal. It contains information about +the terminal's capabilities (as defined by \fBterminfo\fR), the terminal modes, +and current state of input/output operations. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwchar_t\fR\fR +.ad +.RS 12n +.rt +An integral data type whose values represent wide characters. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBWINDOW\fR\fR +.ad +.RS 12n +.rt +An opaque data type associated with a window. +.RE + +.SS "Screens, Windows, and Terminals" +.sp +.LP +The X/Open Curses manual pages refer at various points to screens, windows +(also subwindows, derived windows, and pads), and terminals. The following list +defines each of these terms. +.sp +.ne 2 +.mk +.na +\fBScreen\fR +.ad +.RS 10n +.rt +A screen is a terminal's physical output device. The \fBSCREEN\fR data type is +associated with a terminal. +.RE + +.sp +.ne 2 +.mk +.na +\fBWindow\fR +.ad +.RS 10n +.rt +Window objects are two-dimensional arrays of characters and their renditions. +X/Open Curses provides \fIstdscr\fR, a default window which is the size of of +the terminal screen. You can use the \fBnewwin\fR(3XCURSES) function to create +others. +.RE + +.sp +.LP +To refer to a window, use a variable declared as \fBWINDOW *\fR. X/Open Curses +includes both functions that modify \fIstdscr\fR, and more general versions +that let you specify a window. +.sp +.LP +There are three sub-types of windows: +.sp +.ne 2 +.mk +.na +\fBSubwindow\fR +.ad +.RS 18n +.rt +A window which has been created within another window (the parent window) and +whose position has been specified with absolute screen coordinates. The +\fBderwin\fR(3XCURSES) and \fBsubwin\fR(3XCURSES) functions can be used to +create subwindows. +.RE + +.sp +.ne 2 +.mk +.na +\fBDerived Window\fR +.ad +.RS 18n +.rt +A subwindow whose position is defined relative to the parent window's +coordinates rather than in absolute terms. +.RE + +.sp +.ne 2 +.mk +.na +\fBPad\fR +.ad +.RS 18n +.rt +A special type of window that can be larger than the screen. For more +information, see the \fBnewpad\fR(3XCURSES) man page. +.RE + +.sp +.ne 2 +.mk +.na +\fBTerminal\fR +.ad +.RS 18n +.rt +A terminal is the input and output device which character-based applications +use to interact with the user. The \fBTERMINAL\fR data type is associated with +such a device. +.RE + +.SS "Attributes, Color Pairs, and Renditions" +.sp +.LP +A character's rendition consists of its attributes (such as underlining or +reverse video) and its color pair (the foreground and background colors). When +using \fBwaddstr\fR(3XCURSES), \fBwaddchstr\fR(3XCURSES), +\fBwprintw\fR(3XCURSES), \fBwinsch\fR(3XCURSES), and so on, the window's +rendition is combined with that character's renditions. The window rendition is +the attributes and color set using the \fBattroff\fR(3XCURSES) and +\fBattr_off\fR(3XCURSES) sets of functions. The window's background character +and rendition are set with the \fBbkgdset\fR(3XCURSES) and +\fBbkgrndset\fR(3XCURSES) sets of functions. +.sp +.LP +When spaces are written to the screen, the background character and window +rendition replace the space. For example, if the background rendition and +character is \fBA_UNDERLINE|'*'\fR, text written to the window appears +underlined and the spaces appear as underlined asterisks. +.sp +.LP +Each character written retains the rendition that it has obtained. This allows +the character to be copied "as is" to or from a window with the +\fBaddchstr\fR(3XCURSES) or \fBinch\fR(3XCURSES) functions. +.SS "A_ Constant Values for Attributes" +.sp +.LP +You can specify Attributes, Color Pairs, and Renditions attributes using the +constants listed in the tables below. The following constants modify objects of +type \fBchtype\fR: +.sp + +.sp +.TS +tab() box; +cw(2.75i) cw(2.75i) +lw(2.75i) lw(2.75i) +. +\fBConstant\fR\fBDescription\fR +_ +\fBA_ALTCHARSET\fRAlternate character set +\fBA_ATTRIBUTES\fRBit-mask to extract attributes +\fBA_BLINK\fRBlinking +\fBA_BOLD\fRBold +\fBA_CHARTEXT\fRBit-mask to extract a character +\fBA_COLOR\fRT{ +Bit-mask to extract color-pair information +T} +\fBA_DIM\fRHalf-bright +\fBA_INVIS\fRInvisible +\fBA_PROTECT\fRProtected +\fBA_REVERSE\fRReverse video +\fBA_STANDOUT\fRHighlights specific to terminal +\fBA_UNDERLINE\fRUnderline +.TE + +.SS "WA_ Constant Values for Attributes" +.sp +.LP +The following constants modify objects of type \fBattr_t\fR: +.sp + +.sp +.TS +tab() box; +cw(2.75i) cw(2.75i) +lw(2.75i) lw(2.75i) +. +\fBConstant\fR\fBDescription\fR +_ +\fBWA_ALTCHARSET\fRAlternate character set +\fBWA_ATTRIBUTES\fRAttribute mask +\fBWA_BLINK\fRBlinking +\fBWA_BOLD\fRBold +\fBWA_DIM\fRHalf-bright +\fBWA_HORIZONTAL\fRHorizontal highlight +\fBWA_INVIS\fRInvisible +\fBWA_LEFT\fRLeft highlist +\fBWA_LOW\fRLow highlist +\fBWA_PROTECT\fRProtected +\fBWA_REVERSE\fRReverse video +\fBWA_RIGHT\fRRight highlight +\fBWA_STANDOUT\fRHighlights specific to terminal +\fBWA_TOP\fRTop highlight +\fBWA_UNDERLINE\fRUnderline +\fBWA_VERTICAL\fRVertical highlight +.TE + +.SS "Color Macros" +.sp +.LP +Colors always appear in pairs; the foreground color of the character itself and +the background color of the field on which it is displayed. The following color +macros are defined: +.sp + +.sp +.TS +tab() box; +cw(2.75i) cw(2.75i) +lw(2.75i) lw(2.75i) +. +\fBMacro\fR\fBDescription\fR +_ +\fBCOLOR_BLACK\fRBlack +\fBCOLOR_BLUE\fRBlue +\fBCOLOR_GREEN\fRGreen +\fBCOLOR_CYAN\fRCyan +\fBCOLOR_RED\fRRed +\fBCOLOR_MAGENTA\fRMagenta +\fBCOLOR_YELLOW\fRYellow +\fBCOLOR_WHITE\fRWhite +.TE + +.sp +.LP +Together, a character's attributes and its color pair form the character's +rendition. A character's rendition moves with the character during any +scrolling or insert/delete operations. If your terminal lacks support for the +specified rendition, X/Open Curses may substitute a different rendition. +.sp +.LP +The \fBCOLOR_PAIR\fR(3XCURSES) function modifies a \fBchtype\fR object. The +\fBPAIR_NUMBER\fR(3XCURSES) function extracts the color pair from a +\fBchtype\fR object. +.SS "Functions for Modifying a Window's Color" +.sp +.LP +The following functions modify a window's color: +.sp + +.sp +.TS +tab() box; +cw(2.75i) cw(2.75i) +lw(2.75i) lw(2.75i) +. +\fBFunction\fR\fBDescription\fR +_ +\fBattr_set()\fR, wattr_set(\|)Change the window's rendition. +\fBcolor_set()\fR, wcolor_set(\|)Set the window's color +.TE + +.SS "Non-Spacing Characters" +.sp +.LP +When the \fBwcwidth\fR(3C) function returns a width of zero for a character, +that character is called a non-spacing character. Non-spacing characters can be +written to a window. Each non-spacing character is associated with a spacing +character (that is, one which does not have a width of zero) and modifies that +character. You cannot address a non-spacing character directly. Whenever you +perform an X/Open Curses operation on the associated character, you are +implicitly addressing the non-spacing character. +.sp +.LP +Non-spacing characters do not have a rendition. For functions that use wide +characters and a rendition, X/Open Curses ignores any rendition specified for +non-spacing characters. Multi-column characters have one rendition that applies +to all columns spanned. +.SS "Complex Characters" +.sp +.LP +The \fBcchar_t\fR date type represents a complex character. A complex character +may contain a spacing character, its associated non-spacing characters, and its +rendition. This implementation of complex characters supports up to 5 +non-spacing characters for each spacing character. +.sp +.LP +When a \fBcchar_t\fR object representing a non-spacing complex character is +written to the screen, its rendition is not used, but rather it becomes +associated with the rendition of the existing character at that location. The +\fBsetcchar\fR(3XCURSES) function initializes an object of type \fBcchar_t\fR. +The \fBgetcchar\fR(3XCURSES) function extracts the contents of a \fBcchar_t\fR +object. +.SS "Display Operations" +.sp +.LP +In adding internationalization support to X/Open Curses, every attempt was made +to minimize the number of changes to the historical CURSES package. This +enables programs written to use the historical implementation of CURSES to use +the internationalized version with little or no modification. The following +rules apply to the internationalized X/Open Curses package: +.RS +4 +.TP +.ie t \(bu +.el o +The cursor can be placed anywhere in the window. Window and screen origins +are (0,0). +.RE +.RS +4 +.TP +.ie t \(bu +.el o +A multi-column character cannot be displayed in the last column, because the +character would appear truncated. Instead, the background character is +displayed in the last column and the multi-column character appears at the +beginning of the next line. This is called wrapping. +.sp +If the original line is the last line in the scroll region and scrolling is +enabled, X/Open Curses moves the contents of each line in the region to the +previous line. The first line of the region is lost. The last line of the +scrolling region contains any wrapped characters. The remainder of that line +is filled with the background character. If scrolling is disabled, X/Open +Curses truncates any character that would extend past the last column of the +screen. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Overwrites operate on screen columns. If displaying a single-column or +multi-column character results in overwriting only a portion of a multi-column +character or characters, background characters are displayed in place of the +non-overwritten portions. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Insertions and deletions operate on whole characters. The cursor is moved to +the first column of the character prior to performing the operation. +.RE +.SS "Overlapping Windows" +.sp +.LP +When windows overlap, it may be necessary to overwrite only part of a +multi-column character. As mentioned earlier, the non-overwritten portions +are replaced with the background character. This results in issues concerning +the \fBoverwrite\fR(3XCURSES), \fBoverlay\fR(3XCURSES), +\fBcopywin\fR(3XCURSES), \fBwnoutrefresh\fR(3XCURSES), and +\fBwrefresh\fR(3XCURSES) functions. +.SS "Special Characters" +.sp +.LP +Some functions assign special meanings to certain special characters: +.sp +.ne 2 +.mk +.na +\fBBackspace\fR +.ad +.RS 22n +.rt +Moves the cursor one column towards the beginning of the line. If the cursor +was already at the beginning of the line, it remains there. All subsequent +characters are added or inserted at this point. +.RE + +.sp +.ne 2 +.mk +.na +\fBCarriage Return\fR +.ad +.RS 22n +.rt +Moves the cursor to the beginning of the current line. If the cursor was +already at the beginning of the line, it remains there. All subsequent +characters are added or inserted at this point. +.RE + +.sp +.ne 2 +.mk +.na +\fBNewline\fR +.ad +.RS 22n +.rt +When adding characters, X/Open Curses fills the remainder of the line with the +background character (effectively truncating the newline) and scrolls the +window as described earlier. All subsequent characters are inserted at the +start of the new line. +.sp +When inserting characters, X/Open Curses fills the remainder of the line with +the background character (effectively truncating the line), moves the cursor to +the beginning of a new line, and scrolls the window as described earlier. All +subsequent characters are placed at the start of the new line. +.RE + +.sp +.ne 2 +.mk +.na +\fBTab\fR +.ad +.RS 22n +.rt +moves subsequent characters to next horizontal tab strop. Default tab stops are +set at 0, 8, 16, and so on. +.sp +When adding or inserting characters, X/Open Curses inserts or adds the +background character into each column until the next tab stop is reached. If +there are no remaining tab stops on the current line, wrapping and scrolling +occur as described earlier. +.RE + +.sp +.ne 2 +.mk +.na +\fBControl Characters\fR +.ad +.RS 22n +.rt +When X/Open Curses functions perform special character processing, they convert +control characters to the \fB^\fR\fIX\fR notation, where \fIX\fR is a +single-column character (uppercase, if it is a letter) and writes that +notation to the window. Functions that retrieve text from the window will +retrieve the converted notation not the original. +.RE + +.sp +.LP +X/Open Curses displays non-printable bytes, that have their high bit set, using +the \fBM-\fR\fIX\fR meta notation where \fIX\fR is the non-printable byte with +its high bit turned off. +.SS "Input Processing" +.sp +.LP +There are four input modes possible with X/Open Curses that affect the behavior +of input functions like \fBgetch\fR(3XCURSES) and \fBgetnstr\fR(3XCURSES). +.sp +.ne 2 +.mk +.na +\fBLine Canonical (Cooked)\fR +.ad +.RS 27n +.rt +In line input mode, the terminal driver handles the input of line units as well +as \fBSIGERASE\fR and \fBSIGKILL\fR character processing. See +\fBtermio\fR(7I) for more information. +.sp +In this mode, the \fBgetch()\fR and \fBgetnstr()\fR functions will not return +until a complete line has been read by the terminal driver, at which point only +the requested number of bytes/characters are returned. The rest of the line +unit remains unread until subsequent call to the \fBgetch()\fR or +\fBgetnstr()\fR functions. +.sp +The functions \fBnocbreak\fR(3XCURSES) and \fBnoraw\fR(3XCURSES) are used to +enter this mode. These functions are described on the \fBcbreak\fR(3XCURSES) +man page which also details which \fBtermios\fR flags are enabled. +.sp +Of the modes available, this one gives applications the least amount of control +over input. However, it is the only input mode possible on a block mode +terminal. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBcbreak\fR Mode\fR +.ad +.RS 27n +.rt +Byte/character input provides a finer degree of control. The terminal driver +passes each byte read to the application without interpreting erase and kill +characters. It is the application's responsibility to handle line editing. It +is unknown whether the signal characters (\fBSIGINTR\fR, \fBSIGQUIT\fR, +\fBSIGSUSP\fR) and flow control characters (\fBSIGSTART\fR, \fBSIGSTOP\fR) are +enabled. To ensure that they are, call the \fBnoraw()\fR function first, then +call the \fBcbreak()\fR function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBhalfdelay\fR Mode\fR +.ad +.RS 27n +.rt +This is the same as the \fBcbreak()\fR mode with a timeout. The terminal +driver waits for a byte to be received or for a timer to expire, in which case +the \fBgetch()\fR function either returns a byte or \fBERR\fR respectively. +This mode overrides timeouts set for an individual window with the +\fBwtimeout()\fR function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBraw\fR Mode\fR +.ad +.RS 27n +.rt +This mode provides byte/character input with the most control for an +application. It is similar to \fBcbreak()\fR mode, but also disables signal +character processing (\fBSIGINTR\fR, \fBSIGSUSP\fR, \fBSIGQUIT\fR) and flow +control processing (\fBSIGSTART\fR, \fBSIGSTOP\fR) so that the application can +process them as it wants. +.RE + +.sp +.LP +These modes affect all X/Open Curses input. The default input mode is +inherited from the parent process when the application starts up. +.sp +.LP +A timeout similar to \fBhalfdelay\fR(3XCURSES) can be applied to individual +windows (see \fBtimeout\fR(3XCURSES)). The \fBnodelay\fR(3XCURSES) function is +equivalent to setting \fBwtimeout\fR(3XCURSES) for a window with a zero timeout +(non-blocking) or infinite delay (blocking). +.sp +.LP +To handle function keys, \fBkeypad\fR(3XCURSES) must be enabled. When it is +enabled, the \fBgetch()\fR function returns a \fBKEY_\fR constant for a +uniquely encoded key defined for that terminal. When \fBkeypad()\fR is +disabled, the \fBgetch()\fR function returns the individual bytes composing +the function key (see \fBgetch\fR(3XCURSES) and \fBwget_wch\fR(3XCURSES)). By +default, \fBkeypad()\fR is disabled. +.sp +.LP +When processing function keys, once the first byte is recognized, a timer is +set for each subsequent byte in the sequence. If any byte in the function key +sequence is not received before the timer expires, the bytes already received +are pushed into a buffer and the original first byte is returned. Subsequent +X/Open Curses input would take bytes from the buffer until exhausted, after +which new input from the terminal will be requested. Enabling and disabling +of the function key interbyte timer is handled by the +\fBnotimeout\fR(3XCURSES) function. By default, \fBnotimeout()\fR is disabled +(that is, the timer is used). +.sp +.LP +X/Open Curses always disables the terminal driver's echo processing. The +\fBecho\fR(3XCURSES) and \fBnoecho\fR(3XCURSES) functions control X/Open Curses +software echoing. When software echoing is enabled, X/Open Curses input +functions echo printable characters, control keys, and meta keys in the input +window at the last cursor position. Functions keys are never echoed. When +software echoing is disabled, it is the application's responsibility to handle +echoing. +.SH EXAMPLES +.LP +\fBExample 1 \fRCopying Single-Column Characters Over Single-Column Characters +.sp +.LP +In the upcoming examples, some characters have special meanings: + +.RS +4 +.TP +.ie t \(bu +.el o +\fB{\fR, \fB[\fR, and \fB(\fR represent the left halves of multi-column +characters. \fB}\fR, \fB]\fR, and \fB)\fR represent the corresponding right +halves of the same multi-column characters. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Alphanumeric characters and periods (\fB\&.\fR) represent single-column +characters. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +The number sign (\fB#\fR) represents the background character. +.RE +.sp +.in +2 +.nf +copywin(s, t, 0, 1, 0, 1, 1, 3, 0) + + s t \(-> t + abcdef ...... .bcd.. + ghijkl ...... .hij.. +.fi +.in -2 + +.sp +.LP + There are no special problems with this situation. + +.LP +\fBExample 2 \fRCopying Multi-column Characters Over Single-Column Characters +.sp +.in +2 +.nf +copywin(s, t, 0, 1, 0, 1, 1, 3, 0) + + s t \(-> t + a[]def ...... .[]d.. + gh()kl ...... .h().. +.fi +.in -2 + +.sp +.LP +There are no special problems with this situation. + +.LP +\fBExample 3 \fRCopying Single-Column Characters From Source Overlaps +Multi-column Characters In Target +.sp +.in +2 +.nf +copywin(s, t, 0, 1, 0, 1, 1, 3, 0) + + s t \(-> t + abcdef [].... #bcd.. + ghijk tol ...(). .hij#. +.fi +.in -2 + +.sp +.LP +Overwriting multi-column characters in \fBt\fR has resulted in the \fB#\fR +background characters being required to erase the remaining halves of the +target's multi-column characters. + +.LP +\fBExample 4 \fRCopy Incomplete Multi-column Characters From Source To Target. +.sp +.in +2 +.nf +copywin(s, t, 0, 1, 0, 1, 1, 3, 0) + + s t \(-> t + []cdef 123456 []cd56 + ghi()l 789012 7hi()2 +.fi +.in -2 + +.sp +.LP +The \fB]\fR and \fB(\fR halves of the multi-column characters have been copied +from the source and expanded in the target outside of the specified target +region. + +.sp +.LP +Consider a pop-up dialog box that contains single-column characters and a base +window that contains multi-column characters and you do the following: + +.sp +.in +2 +.nf +save=dupwin(dialog); /* create backing store */ +overwrite(cursor, save); /* save region to be overlayed */ +wrefresh(dialog); /* display dialog */ +wrefresh(save); /* restore screen image */ +delwin(save); /* release backing store */ +.fi +.in -2 + +.sp +.LP +You can use code similar to this to implement generic \fBpopup()\fR and +\fBpopdown()\fR routines in a variety of CURSES implementations (including BSD +UNIX, and UNIX System V). In the simple case where the base window contains +single-column characters only, it would correctly restore the image that +appeared on the screen before the dialog box was displayed. + +.sp +.LP +However, with multi-column characters, the \fBoverwrite()\fR function might +save a region with incomplete multi-column characters. The +\fBwrefresh(dialog)\fR statement results in the behavior described in example 3 +above. The behavior described in this example (that is, example 4) allows the +\fBwrefresh(save)\fR statement to restore the window correctly. + +.LP +\fBExample 5 \fRCopying An Incomplete Multi-column Character To Region Next To +Screen Margin (Not A Window Edge) +.sp +.LP + Two cases of copying an incomplete multi-column character to a region next to +a screen margin follow: + +.sp +.in +2 +.nf +copywin(s, t, 0, 1, 0, 0, 1, 2, 0) + + s t \(-> t + []cdef 123456 #cd456 + ghijkl 789012 hij012 +.fi +.in -2 + +.sp +.LP +The background character (\fB#\fR) replaces the \fB]\fR character that would +have been copied from the source, because it is not possible to expand the +multi-column character to its complete form. + +.sp +.in +2 +.nf +copywin(s, t, 0, 1, 0, 3, 1, 5, 0) + + s t \(-> t + abcdef 123456 123bcd + ghi()l 789012 789hi# +.fi +.in -2 + +.sp +.LP +This second example is the same as the first, but with the right margin. + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBksh\fR(1), \fBCOLOR_PAIR\fR(3XCURSES), \fBPAIR_NUMBER\fR(3XCURSES), +\fBaddchstr\fR(3XCURSES), \fBattr_off\fR(3XCURSES), \fBattroff\fR(3XCURSES), +\fBbkgdset\fR(3XCURSES), \fBbkgrndset\fR(3XCURSES), \fBcbreak\fR(3XCURSES), +\fBcopywin\fR(3XCURSES), \fBderwin\fR(3XCURSES), \fBecho\fR(3XCURSES), +\fBgetcchar\fR(3XCURSES), \fBgetch\fR(3XCURSES), \fBgetnstr\fR(3XCURSES), +\fBhalfdelay\fR(3XCURSES), \fBinch\fR(3XCURSES), \fBkeypad\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBnewpad\fR(3XCURSES), \fBnewwin\fR(3XCURSES), +\fBnocbreak\fR(3XCURSES), \fBnodelay\fR(3XCURSES), \fBnoecho\fR(3XCURSES), +\fBnoraw\fR(3XCURSES), \fBnotimeout\fR(3XCURSES), \fBoverlay\fR(3XCURSES), +\fBoverwrite\fR(3XCURSES), \fBsetcchar\fR(3XCURSES), \fBsubwin\fR(3XCURSES), +\fBtimeout\fR(3XCURSES), \fBwaddchstr\fR(3XCURSES), \fBwaddstr\fR(3XCURSES), +\fBwcwidth\fR(3C), \fBwget_wch\fR(3XCURSES), \fBwinsch\fR(3XCURSES), +\fBwnoutrefresh\fR(3XCURSES), \fBwprintw\fR(3XCURSES), +\fBwrefresh\fR(3XCURSES), \fBwtimeout\fR(3XCURSES), \fBattributes\fR(5), +\fBenviron\fR(5), \fBstandards\fR(5), \fBtermio\fR(7I) diff --git a/usr/src/man/man3xcurses/def_prog_mode.3xcurses b/usr/src/man/man3xcurses/def_prog_mode.3xcurses new file mode 100644 index 0000000000..1048aff19b --- /dev/null +++ b/usr/src/man/man3xcurses/def_prog_mode.3xcurses @@ -0,0 +1,84 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH def_prog_mode 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +def_prog_mode, def_shell_mode, reset_prog_mode, reset_shell_mode \- +save/restore terminal modes +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBdef_prog_mode\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBdef_shell_mode\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBreset_prog_mode\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBreset_shell_mode\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdef_prog_mode()\fR and \fBdef_shell_mode()\fR functions save the current +terminal modes as "program" (within X/Open Curses) or "shell" (outside X/Open +Curses). The modes are saved automatically by \fBinitscr\fR(3XCURSES), +\fBnewterm\fR(3XCURSES), and \fBsetupterm\fR(3XCURSES). +.sp +.LP +The \fBreset_prog_mode()\fR and \fBreset_shell_mode()\fR functions reset the +current terminal modes to "program" (within X/Open Curses) or "shell" (outside +X/Open Curses). The \fBendwin\fR(3XCURSES) function automatically calls the +\fBreset_shell_mode()\fR function and the \fBdoupdate\fR(3XCURSES) function +calls the \fBreset_prog_mode()\fR function after calling \fBendwin()\fR. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBendwin\fR(3XCURSES), \fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBnewterm\fR(3XCURSES), \fBsetupterm\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/del_curterm.3xcurses b/usr/src/man/man3xcurses/del_curterm.3xcurses new file mode 100644 index 0000000000..aac3e0fbf1 --- /dev/null +++ b/usr/src/man/man3xcurses/del_curterm.3xcurses @@ -0,0 +1,198 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 2001, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH del_curterm 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +del_curterm, restartterm, set_curterm, setupterm \- interfaces to the terminfo +database +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <term.h> + +\fBint\fR \fBdel_curterm\fR(\fBTERMINAL *\fR\fIoterm\fR); +.fi + +.LP +.nf +\fBint\fR \fBrestartterm\fR(\fBchar *\fR\fIterm\fR, \fBint\fR \fIfildes\fR, \fBint *\fR\fIerrret\fR); +.fi + +.LP +.nf +\fBTERMINAL *\fR\fBset_curterm\fR(\fBTERMINAL *\fR\fInterm\fR); +.fi + +.LP +.nf +\fBint\fR \fBsetupterm\fR(\fBchar *\fR\fIterm\fR, \fBint\fR \fIfildes\fR, \fBint *\fR\fIerrret\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +Within X/Open Curses, the \fBsetupterm()\fR function is automatically called by +the initscr (3XC) and newterm (3XC) functions. This function can be also be +used outside of X/Open Curses when a program has to deal directly with the +\fBterminfo\fR database to handle certain terminal capabilities. The use of +appropriate X/Open Curses functions is recommended in all other situations. +.sp +.LP +The \fBsetupterm()\fR function loads terminal-dependent variables for the +\fBterminfo\fR layer of X/Open Curses. The \fBsetupterm()\fR function +initializes the \fBterminfo\fR variables \fBlines\fR and \fBcolumns\fR such +that if \fBuse_env(FALSE)\fR has been called, the \fBterminfo\fR values +assigned in the database are used regardless of the environmental variables +\fBLINES\fR and \fBCOLUMNS\fR or the program's window dimensions; when +\fBuse_env(TRUE)\fR has been called, which is the default, the environment +variables \fBLINES\fR and \fBCOLUMNS\fR are used, if they exist. If the +environment variables do not exist and the program is running in a window, the +current window size is used. +.sp +.LP +The \fIterm\fR parameter of \fBsetupterm()\fR specifies the terminal; if null, +terminal type is taken from the \fBTERM\fR environment variable. All output is +sent to \fIfildes\fR which is initialized for output. If \fIerrret\fR is not +null, \fBOK\fR or \fBERR\fR is returned and a status value is stored in the +integer pointed to by \fIerrret\fR. The following status values may be +returned: +.sp + +.sp +.TS +tab() box; +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +\fBValue\fR\fBDescription\fR +\fB1\fRNormal +\fB0\fRTerminal could not be found +\fB-1\fR\fBterminfo\fR database could not be found +.TE + +.sp +.LP +If \fIerrret\fR is null, an error message is printed, and the \fBsetupterm()\fR +function calls the \fBexit()\fR function with a non-zero parameter. +.sp +.LP +The \fBset_curterm()\fR function sets the \fBcur_term\fR variable to +\fInterm\fR. The values from \fInterm\fR as well as other state information for +the terminal are used by X/Open Curses functions such as \fBbeep\fR(3XCURSES), +\fBflash\fR(3XCURSES), \fBmvcur\fR(3XCURSES), \fBtigetflag\fR(3XCURSES), +\fBtigetstr\fR(3XCURSES), and \fBtigetnum\fR(3XCURSES). +.sp +.LP +The \fBdel_curterm()\fR function frees the space pointed to by \fIoterm\fR. If +\fIoterm\fR and the \fBcur_term\fR variable are the same, all Boolean, numeric, +or string \fBterminfo\fR variables will refer to invalid memory locations until +you call \fBsetupterm()\fR and specify a new terminal type. +.sp +.LP +The \fBrestartterm()\fR function assumes that a call to \fBsetupterm()\fR has +already been made (probably from \fBinitscr()\fR or \fBnewterm()\fR). It allows +you to specify a new terminal type in \fIterm\fR and updates the data returned +by \fBbaudrate\fR(3XCURSES) based on \fIfildes\fR. Other information created by +the \fBinitscr()\fR, \fBnewterm()\fR, and \fBsetupterm()\fR functions is +preserved. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoterm\fR\fR +.ad +.RS 10n +.rt +Is the terminal type for which to free space. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIterm\fR\fR +.ad +.RS 10n +.rt +Is the terminal type for which variables are set. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIfildes\fR\fR +.ad +.RS 10n +.rt +Is a file descriptor initialized for output. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIerrret\fR\fR +.ad +.RS 10n +.rt +Is a pointer to an integer in which the status value is stored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fInterm\fR\fR +.ad +.RS 10n +.rt +Is the new terminal to become the current terminal. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, the \fBset_curterm()\fR function returns the previous value of +\fBcur_term\fR. Otherwise, it returns a null pointer. +.sp +.LP +On success, the other functions return \fBOK\fR. Otherwise, they return +\fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbaudrate\fR(3XCURSES), \fBbeep\fR(3XCURSES), \fBinitscr\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBmvcur\fR(3XCURSES), \fBtigetflag\fR(3XCURSES), +\fBuse_env\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/delay_output.3xcurses b/usr/src/man/man3xcurses/delay_output.3xcurses new file mode 100644 index 0000000000..9334bde8f6 --- /dev/null +++ b/usr/src/man/man3xcurses/delay_output.3xcurses @@ -0,0 +1,71 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH delay_output 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +delay_output \- delays output +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBdelay_output\fR(\fBint\fR \fIms\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdelay_output()\fR function delays output for \fIms\fR milliseconds by +inserting pad characters in the output stream. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIms\fR\fR +.ad +.RS 6n +.rt +Is the number of milliseconds to delay the output. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, the \fBdelay_output()\fR function returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBnapms\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/delch.3xcurses b/usr/src/man/man3xcurses/delch.3xcurses new file mode 100644 index 0000000000..70f8dafaad --- /dev/null +++ b/usr/src/man/man3xcurses/delch.3xcurses @@ -0,0 +1,115 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH delch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +delch, mvdelch, mvwdelch, wdelch \- remove a character +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBdelch\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvdelch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwdelch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBint\fR \fBwdelch\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdelch()\fR and \fBwdelch()\fR functions delete the character at the +current cursor position from \fBstdscr\fR and \fIwin\fR, respectively. All +remaining characters after cursor through to the end of the line are shifted +one character towards the start of the line. The last character on the line +becomes a space; characters on other lines are not affected. +.sp +.LP +The \fBmvdelch()\fR and \fBmvwdelch()\fR functions delete the character at the +position specified by the \fIx\fR and \fIy\fR parameters; the former deletes +the character from \fBstdscr\fR; the latter from \fIwin\fR. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the position of the character to be removed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the position of the character to be removed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window containing the character to be removed. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgdset\fR(3XCURSES), \fBinsch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/deleteln.3xcurses b/usr/src/man/man3xcurses/deleteln.3xcurses new file mode 100644 index 0000000000..2fabde5d88 --- /dev/null +++ b/usr/src/man/man3xcurses/deleteln.3xcurses @@ -0,0 +1,77 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH deleteln 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +deleteln, wdeleteln \- remove a line +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBdeleteln\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwdeleteln\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdeleteln()\fR and \fBwdeleteln()\fR functions delete the line +containing the cursor from \fBstdscr\fR and \fIwin\fR, respectively. All lines +below the one deleted are moved up one line. The last line of the window +becomes blank. The position of the cursor is unchanged. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window from which the line is removed. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgdset\fR(3XCURSES), \fBinsdelln\fR(3XCURSES), \fBinsertln\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/delscreen.3xcurses b/usr/src/man/man3xcurses/delscreen.3xcurses new file mode 100644 index 0000000000..834794eb70 --- /dev/null +++ b/usr/src/man/man3xcurses/delscreen.3xcurses @@ -0,0 +1,71 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH delscreen 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +delscreen \- free space associated with the SCREEN data structure +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBvoid\fR \fBdelscreen\fR(\fBSCREEN *\fR\fIsp\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdelscreen()\fR function frees space associated with the \fBSCREEN\fR +data structure. This function should be called after \fBendwin\fR(3XCURSES) if +a \fBSCREEN\fR data structure is no longer needed. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIsp\fR\fR +.ad +.RS 6n +.rt +Is a pointer to the screen structure for which to free space. +.RE + +.SH RETURN VALUES +.sp +.LP +The \fBdelscreen()\fR function does not return a value. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBendwin\fR(3XCURSES), \fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBnewterm\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/delwin.3xcurses b/usr/src/man/man3xcurses/delwin.3xcurses new file mode 100644 index 0000000000..5fe54fd803 --- /dev/null +++ b/usr/src/man/man3xcurses/delwin.3xcurses @@ -0,0 +1,74 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH delwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +delwin \- delete a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBdelwin\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdelwin()\fR function deletes the specified window, freeing up the memory +associated with it. +.sp +.LP +Deleting a parent window without deleting its subwindows and then trying to +manipulate the subwindows will have undefined results. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window that is to be deleted. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, this functions returns \fBOK\fR. Otherwise, it returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBderwin\fR(3XCURSES), \fBdupwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/derwin.3xcurses b/usr/src/man/man3xcurses/derwin.3xcurses new file mode 100644 index 0000000000..e700f48fff --- /dev/null +++ b/usr/src/man/man3xcurses/derwin.3xcurses @@ -0,0 +1,158 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH derwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +derwin, newwin, subwin \- create a new window or subwindow +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBWINDOW *\fR\fBderwin\fR(\fBWINDOW *\fR\fIorig\fR, \fBint\fR \fInlines\fR, \fBint\fR \fIncols\fR, + \fBint\fR \fIbegin_y\fR, \fBint\fR \fIbegin_x\fR); +.fi + +.LP +.nf +\fBWINDOW *\fR\fBnewwin\fR(\fBint\fR \fInlines\fR, \fBint\fR \fIncols\fR, \fBint\fR \fIbegin_y\fR, \fBint\fR \fIbegin_x\fR); +.fi + +.LP +.nf +\fBWINDOW *\fR\fBsubwin\fR(\fBWINDOW *\fR\fIorig\fR, \fBint\fR \fInlines\fR, \fBint\fR \fIncols\fR, \fBint\fR \fIbegin_y\fR, + \fBint\fR \fIbegin_x\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBderwin()\fR function creates a subwindow within window \fIorig\fR, with +the specified number of lines and columns, and upper left corner positioned at +\fIbegin_x\fR, \fIbegin_y\fR relative to window \fIorig\fR. A pointer to the +new window structure is returned. +.sp +.LP +The \fBnewwin()\fR function creates a new window with the specified number of +lines and columns and upper left corner positioned at \fIbegin_x\fR, +\fIbegin_y\fR. A pointer to the new window structure is returned. A +full-screen window can be created by calling \fBnewwin(0,0,0,0)\fR. +.sp +.LP +If the number of lines specified is zero, \fBnewwin()\fR uses a default value +of \fBLINES\fR minus \fIbegin_y\fR; if the number of columns specified is +zero, \fBnewwin()\fR uses the default value of \fBCOLS\fR minus \fIbegin_x\fR. +.sp +.LP +The \fBsubwin()\fR function creates a subwindow within window \fIorig\fR, with +the specified number of lines and columns, and upper left corner positioned at +\fIbegin_x\fR, \fIbegin_y\fR (relative to the physical screen, \fInot\fR to +window \fIorig\fR). A pointer to the new window structure is returned. +.sp +.LP +The original window and subwindow share character storage of the overlapping +area (each window maintains its own pointers, cursor location, and other +items). This means that characters and attributes are identical in overlapping +areas regardless of which window characters are written to. +.sp +.LP +When using subwindows, it is often necessary to call \fBtouchwin\fR(3XCURSES) +before \fBwrefresh\fR(3XCURSES) to maintain proper screen contents. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIorig\fR\fR +.ad +.RS 11n +.rt +Is a pointer to the parent window for the newly created subwindow. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fInlines\fR\fR +.ad +.RS 11n +.rt +Is the number of lines in the subwindow. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIncols\fR\fR +.ad +.RS 11n +.rt +Is the number of columns in the subwindow. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbegin_y\fR\fR +.ad +.RS 11n +.rt +Is the y (row) coordinate of the upper left corner of the subwindow, relative +to the parent window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbegin_x\fR\fR +.ad +.RS 11n +.rt +Is the x (column) coordinate of the upper left corner of the subwindow, +relative to the parent window. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return a pointer to the newly-created window. +Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBis_linetouched\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/doupdate.3xcurses b/usr/src/man/man3xcurses/doupdate.3xcurses new file mode 100644 index 0000000000..88e96b9c36 --- /dev/null +++ b/usr/src/man/man3xcurses/doupdate.3xcurses @@ -0,0 +1,107 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH doupdate 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +doupdate, refresh, wnoutrefresh, wrefresh \- refresh windows and lines +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBdoupdate\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBrefresh\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwnoutrefresh\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBwrefresh\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBrefresh()\fR and \fBwrefresh()\fR functions copy \fBstdscr\fR and +\fIwin\fR, respectively, to the terminal screen. These functions call the +\fBwnoutrefresh()\fR function to copy the specified window to \fBcurscr\fR and +the \fBdoupdate()\fR function to do the actual update. The physical cursor is +mapped to the same position as the logical cursor of the last window to update +\fBcurscr\fR unless \fBleaveok\fR(3XCURSES) is enabled (in which case, the +cursor is placed in a position that X/Open Curses finds convenient). +.sp +.LP +When outputting several windows at once, it is often more efficient to call the +\fBwnoutrefresh()\fR and \fBdoupdate()\fR functions directly. A call to +\fBwnoutrefresh()\fR for each window, followed by only one call to +\fBdoupdate()\fR to update the screen, results in one burst of output, fewer +characters sent, and less CPU time used. +.sp +.LP +If the \fIwin\fR parameter to \fBwrefresh()\fR is the global variable +\fBcurscr\fR, the screen is immediately cleared and repainted from scratch. +.sp +.LP +For details on how the \fBwnoutrefresh()\fR function handles overlapping +windows with broad glyphs, see the \fBOverlapping Windows\fR section of the +\fBcurses\fR(3XCURSES) reference manual page. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which to refresh. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBclearok\fR(3XCURSES), \fBcurses\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBprefresh\fR(3XCURSES), \fBredrawwin\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/dupwin.3xcurses b/usr/src/man/man3xcurses/dupwin.3xcurses new file mode 100644 index 0000000000..ce6b804498 --- /dev/null +++ b/usr/src/man/man3xcurses/dupwin.3xcurses @@ -0,0 +1,71 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH dupwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +dupwin \- duplicate a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBWINDOW *\fR\fBdupwin\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBdupwin()\fR function creates a duplicate of window \fIwin\fR. A pointer +to the new window structure is returned. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window that is to be duplicated. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, this function returns a pointer to new window structure; otherwise, +it returns a null pointer. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdelwin\fR(3XCURSES), \fBderwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/echo.3xcurses b/usr/src/man/man3xcurses/echo.3xcurses new file mode 100644 index 0000000000..f7f302ee21 --- /dev/null +++ b/usr/src/man/man3xcurses/echo.3xcurses @@ -0,0 +1,69 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH echo 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +echo, noecho \- enable/disable terminal echo +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBecho\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBnoecho\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBecho()\fR function enables Echo mode for the current screen. The +\fBnoecho()\fR function disables Echo mode for the current screen. Initially, +curses software echo mode is enabled and hardware echo mode of the \fBtty\fR +driver is disabled. The \fBecho()\fR and \fBnoecho()\fR functions control +software echo only. Hardware echo must remain disabled for the duration of the +application, else the behavior is undefined. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, these functions return \fBOK\fR. Otherwise, they +return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetch\fR(3XCURSES), \fBgetstr\fR(3XCURSES), \fBinitscr\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBscanw\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/echo_wchar.3xcurses b/usr/src/man/man3xcurses/echo_wchar.3xcurses new file mode 100644 index 0000000000..aa2c8887f3 --- /dev/null +++ b/usr/src/man/man3xcurses/echo_wchar.3xcurses @@ -0,0 +1,88 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH echo_wchar 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +echo_wchar, wecho_wchar \- add a complex character and refresh window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBecho_wchar\fR(\fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwecho_wchar\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBecho_wchar()\fR function produces the same effect as calling +\fBadd_wch\fR(3XCURSES) and then \fBrefresh\fR(3XCURSES). The +\fBwecho_wchar()\fR function produces the same effect as calling +\fBwadd_wch\fR(3XCURSES) and then \fBwrefresh\fR(3XCURSES). +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the complex character to be written to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the character is to be added. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBechochar\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/echochar.3xcurses b/usr/src/man/man3xcurses/echochar.3xcurses new file mode 100644 index 0000000000..36d86e1e60 --- /dev/null +++ b/usr/src/man/man3xcurses/echochar.3xcurses @@ -0,0 +1,88 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH echochar 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +echochar, wechochar \- add a single-byte character and refresh window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBechochar\fR(\fBconst chtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwechochar\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst chtype\fR \fIch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBechochar()\fR function produces the same effect as calling +\fBaddch\fR(3XCURSES) and then \fBrefresh\fR(3XCURSES). The \fBwechochar()\fR +function produces the same effect as calling \fBwaddch\fR(3XCURSES) and then +\fBwrefresh\fR(3XCURSES). +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the character to be written to the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the character is to be added. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBecho_wchar\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/endwin.3xcurses b/usr/src/man/man3xcurses/endwin.3xcurses new file mode 100644 index 0000000000..1cd65b8078 --- /dev/null +++ b/usr/src/man/man3xcurses/endwin.3xcurses @@ -0,0 +1,77 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH endwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +endwin, isendwin \- restore initial terminal environment +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBendwin\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBbool\fR \fBisendwin\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBendwin()\fR function restores the terminal after Curses activity by at +least restoring the saved shell terminsl mode, flushing any output to the +terminal, and moving the cursor to the first column of the last line of the +screen. Refreshing a window resumes program mode. The application must call +\fBendwin()\fR for each terminal being used before exiting. If +\fBnewterm\fR(3XCURSES) is called more than once for the same terminal, the +first screen created must be the last one for which \fBendwin()\fR is called. +.sp +.LP +The \fBisendiwin()\fR function indicates whether or not a screen has been +refreshed since the last call to \fBendwin()\fR. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, the \fBendwin()\fR function returns \fBOK\fR. +Otherwise, it returns \fBERR\fR. +.sp +.LP +The \fBisendwin()\fR function returns \fBTRUE\fR if \fBendwin()\fR has been +called without any subsequent refresh. Otherwise, it returns \fBFALSE\fR. +.SH ERRORS +.sp +.LP +Non errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewterm\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/erasechar.3xcurses b/usr/src/man/man3xcurses/erasechar.3xcurses new file mode 100644 index 0000000000..861c75c110 --- /dev/null +++ b/usr/src/man/man3xcurses/erasechar.3xcurses @@ -0,0 +1,98 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH erasechar 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +erasechar, erasewchar, killchar, killwchar \- return current ERASE or KILL +characters +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBchar\fR \fBerasechar\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBerasewchar\fR(\fBwchar_t *\fR\fIch\fR); +.fi + +.LP +.nf +\fBchar\fR \fBkillchar\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBkillwchar\fR(\fBwchar_t *\fR\fIch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBerasechar()\fR function returns the current ERASE character from the +tty driver. This character is used to delete the previous character during +keyboard input. The returned value can be used when including deletion +capability in interactive programs. +.sp +.LP +The \fBkillchar()\fR function is similar to \fBerasechar()\fR. It returns the +current KILL character. +.sp +.LP +The \fBerasewchar()\fR and \fBkillwchar()\fR functions are similar to +\fBerasechar()\fR and \fBkillchar()\fR respectively, but store the ERASE or +KILL character in the object pointed to by \fIch\fR. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 6n +.rt +Is a pointer to a location where a character may be stored. +.RE + +.SH RETURN VALUES +.sp +.LP +For \fBerasechar()\fR and \fBkillchar()\fR, the terminal's current ERASE or +KILL character is returned. +.sp +.LP +On success, the \fBerasewchar()\fR and \fBkillwchar()\fR functions return +\fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetch\fR(3XCURSES), \fBgetstr\fR(3XCURSES), \fBget_wch\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/filter.3xcurses b/usr/src/man/man3xcurses/filter.3xcurses new file mode 100644 index 0000000000..17df2a14d6 --- /dev/null +++ b/usr/src/man/man3xcurses/filter.3xcurses @@ -0,0 +1,79 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH filter 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +filter \- disable use of certain terminal capabilities +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBvoid\fR \fBfilter\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBfilter()\fR function changes how X/Open Curses initializes terminal +capabilities that assume the terminal has more than one line. After a call to +\fBfilter()\fR, the \fBinitscr\fR(3XCURSES) or \fBnewterm\fR(3XCURSES) +functions also: +.RS +4 +.TP +.ie t \(bu +.el o +Disable use of \fBclear\fR, \fBcud\fR, \fBcud1\fR, \fBcup\fR, \fBcuu1\fR, and +\fBvpa\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Set \fBhome\fR string to the value of \fBcr\fR. +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Set \fBlines\fR to 1. +.RE +.SH RETURN VALUES +.sp +.LP +The \fBfilter()\fR function does not return a value. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewterm\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/flushinp.3xcurses b/usr/src/man/man3xcurses/flushinp.3xcurses new file mode 100644 index 0000000000..49e25debb9 --- /dev/null +++ b/usr/src/man/man3xcurses/flushinp.3xcurses @@ -0,0 +1,57 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH flushinp 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +flushinp \- discard type-ahead characters +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBflushinp\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBflushinp()\fR function discards (flushes) any characters in the input +buffer associated with the current screen. +.SH RETURN VALUES +.sp +.LP +The \fBflushinp()\fR function always returns \fBOK\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/get_wch.3xcurses b/usr/src/man/man3xcurses/get_wch.3xcurses new file mode 100644 index 0000000000..1a95bbcd39 --- /dev/null +++ b/usr/src/man/man3xcurses/get_wch.3xcurses @@ -0,0 +1,166 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH get_wch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +get_wch, wget_wch, mvget_wch, mvwget_wch \- get a wide character from terminal +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBget_wch\fR(\fBwint_t *\fR\fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwget_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBwint_t *\fR\fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvget_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwget_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIch\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBget_wch()\fR and \fBwget_wch()\fR functions get a wide character from +the terminal associated with the window \fBstdscr\fR or window \fIwin\fR, +respectively. The \fBmvget_wch()\fR and \fBmvwget_wch()\fR functions move the +cursor to the position specified in \fBstdscr\fR or \fIwin\fR, respectively, +then get a character. +.sp +.LP +If the window is not a pad and has been changed since the last call to +\fBrefresh\fR(3XCURSES), \fBget_wch()\fR calls \fBrefresh()\fR to update the +window before the next character is read. +.sp +.LP +The setting of certain functions affects the behavior of the \fBget_wch()\fR +set of functions. For example, if \fBcbreak\fR(3XCURSES) is set, characters +typed by the user are immediately processed. If \fBhalfdelay\fR(3XCURSES) is +set, \fBget_wch()\fR waits until a character is typed or returns \fBERR\fR if +no character is typed within the specified timeout period. This timeout can +also be specified for individual windows with the \fIdelay\fR parameter of +\fBtimeout\fR(3XCURSES) A negative value waits for input; a value of \fB0\fR +returns \fBERR\fR if no input is ready; a positive value blocks until input +arrives or the time specified expires (in which case \fBERR\fR is returned). +If \fBnodelay\fR(3XCURSES) is set, \fBERR\fR is returned if no input is +waiting; if not set, \fBget_wch()\fR waits until input arrives. Each +character will be echoed to the window unless \fBnoecho\fR(3XCURSES) has been +set. +.sp +.LP +If keypad handling is enabled ( \fBkeypad\fR(3XCURSES) is \fBTRUE\fR), the +token for the function key (a \fBKEY_\fR value) is stored in the object pointed +to by \fIch\fR and \fBKEY_CODE_YES\fR is returned. If a character is received +that could be the beginning of a function key (for example, ESC), an +inter-byte timer is set. If the remainder of the sequence is not received +before the time expires, the character is passed through; otherwise, the value +of the function key is returned. If \fBnotimeout()\fR is set, the inter-byte +timer is not used. +.sp +.LP +The ESC key is typically a prefix key used with function keys and should not be +used as a single character. +.sp +.LP +See the \fBgetch\fR(3XCURSES) manual page for a list of tokens for function +keys that are returned by the \fBget_wch()\fR set of functions if keypad +handling is enabled (Some terminals may not support all tokens). +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 7n +.rt +Is a pointer to a wide integer where the returned wide character or \fBKEY_\fR +value can be stored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window associated with the terminal from which the +character is to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate for the position of the character to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate for the position of the character to be read. +.RE + +.SH RETURN VALUES +.sp +.LP +When these functions successfully report the pressing of a function key, they +return \fBKEY_CODE_YES\fR. When they successfully report a wide character, they +return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBcbreak\fR(3XCURSES), \fBecho\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), +\fBkeypad\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnodelay\fR(3XCURSES), +\fBnotimeout\fR(3XCURSES), \fBraw\fR(3XCURSES), \fBtimeout\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/getbegyx.3xcurses b/usr/src/man/man3xcurses/getbegyx.3xcurses new file mode 100644 index 0000000000..773db5d8f4 --- /dev/null +++ b/usr/src/man/man3xcurses/getbegyx.3xcurses @@ -0,0 +1,122 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH getbegyx 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +getbegyx, getmaxyx, getparyx, getyx \- get cursor or window coordinates +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBvoid\fR \fBgetbegyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBgetmaxyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBgetparyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBgetyx\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBgetyx()\fR macro stores the current cursor position of the specified +window in \fIx\fR and \fIy\fR. +.sp +.LP +The \fBgetparyx()\fR macro stores the \fIx\fR and \fIy\fR coordinates (relative +to the parent window) of the specified window's origin (upper-left corner). +If \fIwin\fR does not point to a subwindow, \fIx\fR and \fIy\fR are set to +\(mi1. +.sp +.LP +The \fBgetbegyx()\fR macro stores the \fIx\fR and \fIy\fR coordinates of the +specified window's origin (upper-left corner). +.sp +.LP +The \fBgetmaxyx()\fR macro stores the numbers of rows in the specified window +in \fIy\fR and the number of columns in \fIx\fR. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to a window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +stores the \fIy\fR coordinate for the cursor or origin. The \fBgetmaxyx()\fR +macro uses it to store the number of rows in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +stores the \fIx\fR coordinate for the cursor or origin. The \fBgetmaxyx()\fR +macro uses it to store the number of columns in the window. +.RE + +.SH RETURN VALUES +.sp +.LP +These macros do not return a value. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/getcchar.3xcurses b/usr/src/man/man3xcurses/getcchar.3xcurses new file mode 100644 index 0000000000..244a1a93b5 --- /dev/null +++ b/usr/src/man/man3xcurses/getcchar.3xcurses @@ -0,0 +1,132 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH getcchar 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +getcchar \- get a wide character string (with rendition) from a cchar_t +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBgetcchar\fR(\fBconst cchar_t *\fR\fIwcval\fR, \fBwchar_t *\fR\fIwch\fR, \fBattr_t *\fR\fIattrs\fR, + \fBshort *\fR\fIcolor_pair\fR,\fBvoid *\fR\fIopt\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +If \fIwch\fR is not a null pointer, the \fBgetcchar()\fR function splits the +\fBcchar_t\fR object pointed to by \fIwcval\fR into a wide character string, +attributes, and a color pair. It stores the attributes in the location pointed +to by \fIattrs\fR, the color pair in the location pointed to by +\fIcolor_pair\fR, and the wide character string in the location pointed to by +\fIwch\fR. +.sp +.LP +If \fIwch\fR is a null pointer, the \fBgetcchar()\fR function simply returns +the number of wide characters in the \fBcchar_t\fR object pointed to by +\fIwcval\fR. The objects pointed to by \fIattrs\fR and \fIcolor_pair\fR are not +changed. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwcval\fR\fR +.ad +.RS 14n +.rt +Is a pointer to a \fBcchar_t\fR object. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 14n +.rt +Is a pointer to an object where a wide character string can be stored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIattrs\fR\fR +.ad +.RS 14n +.rt +Is a pointer to an object where attributes can be stored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcolor_pair\fR\fR +.ad +.RS 14n +.rt +Is a pointer to an object where a color pair can be stored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIopts\fR\fR +.ad +.RS 14n +.rt +Is reserved for future use. Currently, this must be a null pointer. +.RE + +.SH RETURN VALUES +.sp +.LP +When \fIwch\fR is a null pointer, the \fBgetcchar()\fR function returns the +number of wide characters in the string pointed to by \fIwcval\fR including +the null terminator. +.sp +.LP +When \fIwch\fR is not a null pointer, the \fBgetcchar()\fR function returns +\fBOK\fR on success and \fBERR\fR otherwise. +.SH ERRORS +.sp +.LP +None +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattroff\fR(3XCURSES), \fBcan_change_color\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBsetcchar\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/getch.3xcurses b/usr/src/man/man3xcurses/getch.3xcurses new file mode 100644 index 0000000000..cc8fb4ab9e --- /dev/null +++ b/usr/src/man/man3xcurses/getch.3xcurses @@ -0,0 +1,280 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH getch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +getch, wgetch, mvgetch, mvwgetch \- get a single-byte character from the +terminal +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBgetch\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwgetch\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvgetch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwgetch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window associated with the terminal from which the +character is to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate for the position of the character to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate for the position of the character to be read. +.RE + +.SH DESCRIPTION +.sp +.LP +These functions read a single-byte character from the terminal associated with +the current or specified window. The results are unspecified if the input is +not a single-byte character. If \fBkeypad\fR(3XCURSES) is enabled, these +functions respond to the pressing of a function key by returning the +corresponding \fBKEY_\fR value defined in <\fBcurses.h\fR> +.sp +.LP +Processing of terminal input is subject to the general rules described on the +\fBkeypad\fR(3XCURSES) manual page. +.sp +.LP +If echoing is enabled, then the character is echoed as though it were provided +as an input argument to \fBaddch\fR(3XCURSES), except for the following +characters: +.sp +.ne 2 +.mk +.na +\fB<backspace>\fR +.ad +.RS 17n +.rt +The input is interpreted as follows: unless the cursor already was in column 0, +<backspace> moves the cursor one column toward the start of the current line +and any characters after the <backspace> are added or inserted starting there. +The character at the resulting cursor position it then deleted as though +\fBdelch\fR(3XCURSES) were called, except that if the cursor was originally in +the first column of the line, the user is alerted as though +\fBbeep\fR(3XCURSES) were called. +.RE + +.sp +.ne 2 +.mk +.na +\fBFunction keys\fR +.ad +.RS 17n +.rt +The user is alerted as though \fBbeep()\fR were called. Information concerning +the function keys is not returned to the caller. +.RE + +.sp +.LP +If the current or specified window is not a pad, and it has been moved modified +since the last refresh operation, then it will be refreshed before another +character is read. +.SS "Constant Values for Function Keys" +.sp +.LP +The following is a list of tokens for function keys that are returned by the +\fBgetch()\fR set of functions if keypad handling is enabled (some terminals +may not support all tokens). +.sp + +.sp +.TS +tab() box; +cw(1.65i) cw(3.85i) +lw(1.65i) lw(3.85i) +. +\fBConstant\fR\fBDescription\fR +_ +KEY_BREAKBreak key +KEY_DOWNThe down arrow key +KEY_UPThe up arrow key +KEY_LEFTThe left arrow key +KEY_RIGHTThe right arrow key +KEY_HOMEHome key +KEY_BACKSPACEBackspace +KEY_F0T{ +Function keys. Space for 64 keys is reserved. +T} +KEY_F(\fIn\fR)For 0 <= \fIn\fR <= 63 +KEY_DLDelete line +KEY_ILInsert line +KEY_DCDelete character +KEY_ICInsert char or enter insert mode +KEY_EICExit insert char mode +KEY_CLEARClear screen +KEY_EOSClear to end of screen +KEY_EOLClear to end of line +KEY_SFScroll 1 line forward + KEY_SRScroll 1 line backwards +KEY_NPAGENext page +KEY_PPAGEPrevious page +KEY_STABSet tab +KEY_CTABClear tab +KEY_CATABClear all tabs +KEY_ENTEREnter or send +KEY_SRESETSoft (partial) reset +KEY_RESETReset or hard reset +KEY_PRINTPrint or copy +KEY_LLHome down or bottom (lower left) +KEY_A1Upper left of keypad +KEY_A3Upper right of keypad +KEY_B2Center of keypad +KEY_C1Lower left of keypad +KEY_C3Lower right of keypad +KEY_BTABBack tab +KEY_BEGBeginning key +KEY_CANCELCancel key +KEY_CLOSEClose key +KEY_COMMANDCmd (command) key +KEY_COPYCopy key +KEY_CREATECreate key +KEY_ENDEnd key +KEY_EXITExit key +KEY_FINDFind key +KEY_HELPHelp key +KEY_MARKMark key +KEY_MESSAGEMessage key +KEY_MOVEMove key +KEY_NEXTNext object key +KEY_OPENOpen key +KEY_OPTIONSOptions key +KEY_PREVIOUSPrevious object key +KEY_REDORedo key +KEY_REFERENCEReference key +KEY_REFRESHRefresh key +KEY_REPLACEReplace key +KEY_RESTARTRestart key +KEY_RESUMEResume key +KEY_SAVESave key +KEY_SBEGShifted beginning key +KEY_SCANCELShifted cancel key +KEY_SCOMMANDShifted command key +KEY_SCOPYShifted copy key +KEY_SCREATEShifted create key +KEY_SDCShifted delete char key +KEY_SDLShifted delete line key +KEY_SELECTSelect key +KEY_SENDShifted end key +KEY_SEOLShifted clear line key +KEY_SEXITShifted exit key +KEY_SFINDShifted find key +KEY_SHELPShifted help key +KEY_SHOMEShifted home key +KEY_SICShifted input key +KEY_SLEFT Shifted left arrow key +KEY_SMESSAGESShifted messages key +KEY_SMOVEShifted move key +KEY_SNEXTShifted next key +KEY_SOPTIONSShifted options key +KEY_SPREVIOUSShifted previous key +KEY_SPRINTShifted print key +KEY_SREDOShifted redo key +KEY_SREPLACEShifted replace key +KEY_SRIGHTShifted right arrow key +KEY_SRSUMEShifted resume key +KEY_SSAVEShifted save key +KEY_SSUSPENDShifted suspend key +KEY_SUNDOShifted undo key +KEY_SUSPENDSuspend key +KEY_UNDOUndo key +.TE + +.SH RETURN VALUES +.sp +.LP +Upon successful completion, these functions return the single-byte character, +\fBKEY_\fR value, or \fBERR\fR. When in the nodelay mode and no data is +available, \fBERR\fR is returned. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +Applications should not define the escape key by itself as a single-character +function. +.sp +.LP +When using these functions, nocbreak mode (\fBcbreak\fR(3XCURSES)) and echo +mode (\fBecho\fR(3XCURSES)) should not be used at the same time. Depending on +the state of the terminal when each character is typed, the application may +produce undesirable results. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBcbreak\fR(3XCURSES), \fBecho\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), +\fBkeypad\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnodelay\fR(3XCURSES), +\fBnotimeout\fR(3XCURSES), \fBraw\fR(3XCURSES), \fBtimeout\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/getn_wstr.3xcurses b/usr/src/man/man3xcurses/getn_wstr.3xcurses new file mode 100644 index 0000000000..2a6ceb1654 --- /dev/null +++ b/usr/src/man/man3xcurses/getn_wstr.3xcurses @@ -0,0 +1,166 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH getn_wstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +getn_wstr, get_wstr, mvgetn_wstr, mvget_wstr, mvwgetn_wstr, mvwget_wstr, +wgetn_wstr, wget_wstr \- get a wide character string from terminal +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBgetn_wstr\fR(\fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBget_wstr\fR(\fBwint_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvgetn_wstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvget_wstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwgetn_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwget_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwint_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwgetn_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwint_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwget_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBwint_t *\fR\fIwstr\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBget_wstr()\fR and \fBwget_wstr()\fR functions get a wide character +string from the terminal associated with the window \fBstdscr\fR or window +\fIwin\fR, respectively. The \fBmvget_str()\fR and \fBmvwget_wstr()\fR +functions move the cursor to the position specified in \fBstdscr\fR or +\fIwin\fR, respectively, then get a wide character string. +.sp +.LP +These functions call \fBwget_wch\fR(3XCURSES) and place each received character +in \fIwstr\fR until a newline character, end-of-line character, or end-of-file +character is received, which is also placed in \fIwstr\fR. The erase and kill +characters set by the user are processed. +.sp +.LP +The \fBgetn_wstr()\fR, \fBmvgetn_wstr()\fR, \fBmvwgetn_wstr()\fR and +\fBwgetn_wstr()\fR functions read at most \fIn\fR characters. These functions +are used to prevent overflowing the input buffer. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwstr\fR\fR +.ad +.RS 8n +.rt +Is a pointer to the area where the character string is to be placed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 8n +.rt +Is the maximum number of characters to read from input. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 8n +.rt +Is the y (row) coordinate of starting position of character string to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 8n +.rt +Is the x (column) coordinate of starting position of character string to be +read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 8n +.rt +points to the window associated with the terminal from which the character is +to be read. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBget_wch\fR(3XCURSES), \fBgetnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/getnstr.3xcurses b/usr/src/man/man3xcurses/getnstr.3xcurses new file mode 100644 index 0000000000..2100cfa3fa --- /dev/null +++ b/usr/src/man/man3xcurses/getnstr.3xcurses @@ -0,0 +1,171 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH getnstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +getnstr, getstr, mvgetnstr, mvgetstr, mvwgetnstr, mvwgetstr, wgetnstr, wgetstr +\- get a multibyte character string from terminal +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBgetnstr\fR(\fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBgetstr\fR(\fBchar *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvgetnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvgetstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwgetnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwgetstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwgetnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwgetstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBgetstr()\fR and \fBwgetstr()\fR functions get a character string from +the terminal associated with the window \fBstdscr\fR or window \fIwin\fR, +respectively. The \fBmvgetstr()\fR and \fBmvwgetstr()\fR functions move the +cursor to the position specified in \fBstdscr\fR or \fIwin\fR, respectively, +then get a character string. +.sp +.LP +These functions call \fBwgetch\fR(3XCURSES) and place each received character +in \fIstr\fR until a newline is received, which is also placed in \fIstr\fR. +The erase and kill characters set by the user are processed. +.sp +.LP +The \fBgetnstr()\fR, \fBmvgetnstr()\fR, \fBmvwgetnstr()\fR and +\fBwgetnstr()\fR functions read at most \fIn\fR characters. These functions +are used to prevent overflowing the input buffer. +.sp +.LP +The \fBgetnstr()\fR, \fBwgetnstr()\fR, \fBmvgetnstr()\fR, and +\fBmvwgetnstr()\fR functions only return complete multibyte characters. If the +area pointed to by \fIstr\fR is not large enough to hold at least one +character, these functions fail. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIstr\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the area where the character string is to be placed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +Is the maximum number of characters to read from input. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of starting position of character string to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of starting position of character string to be +read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Points to the window associated with the terminal from which the character is +to be read. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/getwin.3xcurses b/usr/src/man/man3xcurses/getwin.3xcurses new file mode 100644 index 0000000000..69ca2728f6 --- /dev/null +++ b/usr/src/man/man3xcurses/getwin.3xcurses @@ -0,0 +1,97 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH getwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +getwin, putwin \- read a window from, and write a window to, a file +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBWINDOW *\fR\fBgetwin\fR(\fBFILE *\fR\fIfilep\fR); +.fi + +.LP +.nf +\fBint\fR \fBputwin\fR(\fBWINDOW *\fR\fIwin\fR, \fBFILE *\fR\fIfilep\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBgetwin()\fR function reads window-related data (written earlier by +\fBputwin()\fR) from the \fBstdio\fR stream pointed to by \fIfilep\fR. It then +creates and initializes a new window using that data. +.sp +.LP +The \fBputwin()\fR function writes all the data associated with the window +pointed to by \fIwin\fR to the \fBstdio\fR stream pointed to by \fIfilep\fR. +The \fBgetwin()\fR function can later retrieve this data. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIfilep\fR\fR +.ad +.RS 9n +.rt +Is a pointer to a \fBstdio\fR stream. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to a window. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, the \fBgetwin()\fR function returns a pointer to the new window +created. Otherwise, it returns a null pointer. +.sp +.LP +On success, the \fBputwin()\fR function returns \fBOK\fR. Otherwise, it returns +\fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBscr_dump\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/halfdelay.3xcurses b/usr/src/man/man3xcurses/halfdelay.3xcurses new file mode 100644 index 0000000000..920c575629 --- /dev/null +++ b/usr/src/man/man3xcurses/halfdelay.3xcurses @@ -0,0 +1,76 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH halfdelay 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +halfdelay \- enable/disable half-delay mode +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBhalfdelay\fR(\fBint\fR \fItenths\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBhalfdelay()\fR function is similar to \fBcbreak\fR(3XCURSES) in that +when set, characters typed by the user are immediately processed by the +program. The difference is that \fBERR\fR is returned if no input is received +after \fItenths\fR tenths seconds. +.sp +.LP +The \fBnocbreak\fR(3XCURSES) function should be used to leave half-delay mode. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fItenths\fR\fR +.ad +.RS 10n +.rt +Is the number of tenths of seconds for which to block input (1 to 255). +.RE + +.SH RETURN VALUES +.sp +.LP +On success, the \fBhalfdelay()\fR function returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBcbreak\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/has_ic.3xcurses b/usr/src/man/man3xcurses/has_ic.3xcurses new file mode 100644 index 0000000000..8ace6e7a09 --- /dev/null +++ b/usr/src/man/man3xcurses/has_ic.3xcurses @@ -0,0 +1,71 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH has_ic 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +has_ic, has_il \- determine insert/delete character/line capability +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBbool\fR \fBhas_ic\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBbool\fR \fBhas_il\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBhas_ic()\fR function determines whether or not the terminal has +insert/delete character capability. +.sp +.LP +The \fBhas_il()\fR function determines whether or not the terminal has +insert/delete line capability. +.SH RETURN VALUES +.sp +.LP +The \fBhas_ic()\fR function returns \fBTRUE\fR if the terminal has +insert/delete character capability and \fBFALSE\fR otherwise. +.sp +.LP +The \fBhas_il()\fR function returns \fBTRUE\fR if the terminal has +insert/delete line capability and \fBFALSE\fR otherwise. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/hline.3xcurses b/usr/src/man/man3xcurses/hline.3xcurses new file mode 100644 index 0000000000..e76ef24ad4 --- /dev/null +++ b/usr/src/man/man3xcurses/hline.3xcurses @@ -0,0 +1,168 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH hline 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +hline, mvhline, mvvline, mvwhline, mvwvline, vline, whline, wvline \- use +single-byte characters (and renditions) to draw lines +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBhline\fR(\fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvhline\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvvline\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwhline\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwvline\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBvline\fR(\fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwhline\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwvline\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR, \fBint\fR \fIn\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBhline()\fR, \fBvline()\fR, \fBwhline()\fR, \fBwvline()\fR functions +draw a horizontal or vertical line, in either the window \fBstdscr\fR or +\fIwin\fR starting at the current cursor position. The line is drawn using the +character \fIch\fR and is a maximum of \fIn\fR positions long, or as many as +will fit into the window. If \fIch\fR is 0 (zero), the default horizontal or +vertical character is used. +.sp +.LP +The \fBmvhline()\fR, \fBmvvline()\fR, \fBmvwhline()\fR, \fBmvwvline()\fR +functions are similar to the previous group of functions but the line begins +at cursor position specified by \fIx\fR and \fIy\fR. +.sp +.LP +The functions with names ending with \fBhline()\fR draw horizontal lines +proceeding towards the last column of the same line. The functions with names +ending with \fBvline()\fR draw vertical lines proceeding towards the last +column of the same line. +.sp +.LP +These functions do not change the position of the cursor. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 7n +.rt +Is the character used to draw the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +Is the maximum number of characters in the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate for the start of the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate for the start of the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to a window. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBborder\fR(3XCURSES), \fBborder_set\fR(3XCURSES), \fBhline_set\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/hline_set.3xcurses b/usr/src/man/man3xcurses/hline_set.3xcurses new file mode 100644 index 0000000000..65c587922d --- /dev/null +++ b/usr/src/man/man3xcurses/hline_set.3xcurses @@ -0,0 +1,168 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH hline_set 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +hline_set, mvhline_set, mvvline_set, mvwhline_set, mvwvline_set, vline_set, +whline_set, wvline_set \- use complex characters (and renditions) to draw lines +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBhline_set\fR(\fBconst cchar_t *\fR\fIch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvhline_set\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvvline_set\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwhline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwvline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBvline_set\fR(\fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwhline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwvline_set\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR, \fBint\fR \fIn\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBhline_set()\fR, \fBvline_set()\fR, \fBwhline_set()\fR, +\fBwvline_set()\fR functions draw a line, in either the window \fBstdscr\fR or +\fIwin\fR starting at the current cursor position. The line is drawn using the +character \fIwch\fR and is a maximum of \fIn\fR positions long, or as many as +will fit into the window. If \fIwch\fR is a null pointer, the default +horizontal or vertical character is used. +.sp +.LP +The \fBmvhline_set()\fR, \fBmvvline_set()\fR, \fBmvwhline_set()\fR, +\fBmvwvline_set()\fR functions are similar to the previous group of functions +but the line begins at cursor position specified by \fIx\fR and \fIy\fR. +.sp +.LP +The functions with names ending with \fBhline_set()\fR draw horizontal lines +proceeding towards the last column of the same line. The functions with names +ending with \fBvline_set()\fR draw vertical lines proceeding towards the last +column of the same line. +.sp +.LP +These functions do not change the position of the cursor. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 7n +.rt +Is the complex character used to draw the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +Is the maximum number of characters in the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate for the start of the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate for the start of the line. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to a window. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBborder\fR(3XCURSES), \fBborder_set\fR(3XCURSES), \fBhline\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/idcok.3xcurses b/usr/src/man/man3xcurses/idcok.3xcurses new file mode 100644 index 0000000000..09eaeab59b --- /dev/null +++ b/usr/src/man/man3xcurses/idcok.3xcurses @@ -0,0 +1,84 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH idcok 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +idcok \- enable/disable hardware insert-character and delete-character features +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBvoid\fR \fBidcok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBidcok()\fR function enables or disables the use of hardware +insert-character and delete-character features in \fIwin\fR. If \fIbf\fR is +set to \fBTRUE\fR, the use of these features in \fIwin\fR is enabled (if the +terminal is equipped). If \fIbf\fR is set to \fBFALSE\fR, their use in +\fIwin\fR is disabled. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to a window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.SH RETURN VALUES +.sp +.LP +The \fBidcok()\fR function does not return a value. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBclearok\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/immedok.3xcurses b/usr/src/man/man3xcurses/immedok.3xcurses new file mode 100644 index 0000000000..0367eb8d4a --- /dev/null +++ b/usr/src/man/man3xcurses/immedok.3xcurses @@ -0,0 +1,85 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH immedok 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +immedok \- call refresh on changes to window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBimmedok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +If \fIbf\fR is \fBTRUE\fR, \fBimmedok()\fR calls \fBrefresh\fR(3XCURSES) if any +change to the window image is made (for example, through functions such as +\fBaddch\fR(3XCURSES), \fBclrtobot\fR(3XCURSES), and \fBscrl\fR(3XCURSES)). +Repeated calls to \fBrefresh()\fR may affect performance negatively. The +\fBimmedok ()\fR function is disabled by default. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window that is to be refreshed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.SH RETURN VALUES +.sp +.LP +The \fBimmedok()\fR function does not return a value. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBclearok\fR(3XCURSES), \fBclrtobot\fR(3XCURSES), +\fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBscrl\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/in_wch.3xcurses b/usr/src/man/man3xcurses/in_wch.3xcurses new file mode 100644 index 0000000000..ff7f3063b2 --- /dev/null +++ b/usr/src/man/man3xcurses/in_wch.3xcurses @@ -0,0 +1,128 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH in_wch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +in_wch, mvin_wch, mvwin_wch, win_wch \- retrieve a complex character (with +rendition) +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBin_wch\fR(\fBcchar_t *\fR\fIwcval\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvin_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwcval\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwin_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fB\fR\fIinty\fR, \fBcchar_t *\fR\fIwcval\fR); +.fi + +.LP +.nf +\fBint\fR \fBwin_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwcval\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBin_wch()\fR and \fBwin_wch()\fR functions retrieve the complex character +and its rendition located at the current cursor position of the \fBstdscr\fR +window and window \fIwin\fR, respectively. The \fBmvin_wch()\fR and +\fBmvwin_wch()\fR functions retrieve the complex character and its rendition +located at the position indicated by the \fIx\fR (column) and \fIy\fR (row) +parameters (the former in the \fBstdscr\fR window; the latter in window +\fIwin\fR). +.sp +.LP +All these functions store the retrieved character and its rendition in the +object pointed to by \fIwcval\fR. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwcval\fR\fR +.ad +.RS 9n +.rt +Is a pointer to an object that can store a complex character and its rendition. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 9n +.rt +Is the y (row) coordinate of the position of the character to be returned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 9n +.rt +Is the x (column) coordinate of the position of the character to be returned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window that contains the character to be returned. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBinch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/in_wchnstr.3xcurses b/usr/src/man/man3xcurses/in_wchnstr.3xcurses new file mode 100644 index 0000000000..9a956d0cf7 --- /dev/null +++ b/usr/src/man/man3xcurses/in_wchnstr.3xcurses @@ -0,0 +1,170 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH in_wchnstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +in_wchnstr, in_wchstr, mvin_wchnstr, mvin_wchstr, mvwin_wchnstr, mvwin_wchstr, +win_wchnstr, win_wchstr \- retrieve complex character string (with rendition) +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBin_wchnstr\fR(\fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBin_wchstr\fR(\fBcchar_t *\fR\fIwchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvin_wchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvin_wchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwin_wchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwin_wchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBcchar_t *\fR\fIwchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwin_wchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwin_wchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBcchar_t *\fR\fIwchstr\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBin_wchstr()\fR and \fBwin_wchstr()\fR functions retrieve a complex +character string (with rendition) starting at the current cursor position of +the \fBstdscr\fR window and window \fIwin\fR, respectively, and ending at the +right margin. The \fBmvin_wchstr()\fR and \fBmvwin_wchstr()\fR functions +retrieve a complex character string located at the position indicated by the +\fIx\fR (column) and \fIy\fR (row) parameters (the former in the \fBstdscr\fR +window; the latter in window \fIwin\fR). +.sp +.LP +The \fBin_wchnstr()\fR, \fBwin_wchnstr()\fR, \fBmvin_wchnstr()\fR, and +\fBmvwin_wchnstr()\fR functions retrieve at most \fIn\fR characters from the +window \fBstdscr\fR and \fIwin\fR, respectively. The former two functions +retrieve the string, starting at the current cursor position; the latter two +commands retrieve the string, starting at the position specified by the +\fIx\fR and \fIy\fR parameters. +.sp +.LP +The retrieved character string (with renditions) is stored in the object +pointed to by \fIwcval\fR. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwchstr\fR\fR +.ad +.RS 10n +.rt +Is a pointer to an object where the retrieved complex character string can be +stored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 10n +.rt +Is the number of characters not to exceed when retrieving \fIwchstr\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 10n +.rt +Is the y (row) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 10n +.rt +Is the x (column) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 10n +.rt +Is a pointer to the window in which the string is to be retrieved. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBin_wch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/inch.3xcurses b/usr/src/man/man3xcurses/inch.3xcurses new file mode 100644 index 0000000000..e1bbef9e7b --- /dev/null +++ b/usr/src/man/man3xcurses/inch.3xcurses @@ -0,0 +1,118 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH inch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +inch, mvinch, mvwinch, winch \- return a single-byte character (with rendition) +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBchtype\fR \fBinch\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBchtype\fR \fBmvinch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBchtype\fR \fBmvwinch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBchtype\fR \fBwinch\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBinch()\fR and \fBwinch()\fR functions return the \fBchtype\fR character +located at the current cursor position of the \fBstdscr\fR window and window +\fIwin\fR, respectively. The \fBmvinch()\fR and \fBmvwinch()\fR functions +return the \fBchtype\fR character located at the position indicated by the +\fIx\fR (column) and \fIy\fR (row) parameters (the former in the \fBstdscr\fR +window; the latter in window \fIwin\fR). +.sp +.LP +The complete character/attribute pair will be returned. The character or +attributes can be extracted by performing a bitwise \fBAND\fR on the returned +value, using the constants \fBA_CHARTEXT\fR, \fBA_ATTRIBUTES\fR, and +\fBA_COLOR\fR. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the position of the character to be returned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the position of the character to be returned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window that contains the character to be returned. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return the specified character and rendition. +Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/inchnstr.3xcurses b/usr/src/man/man3xcurses/inchnstr.3xcurses new file mode 100644 index 0000000000..b9f8301c29 --- /dev/null +++ b/usr/src/man/man3xcurses/inchnstr.3xcurses @@ -0,0 +1,176 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH inchnstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +inchnstr, inchstr, mvinchnstr, mvinchstr, mvwinchnstr, mvwinchstr, winchnstr, +winchstr \- retrieve a single-byte character string (with rendition) +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBinchnstr\fR(\fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBinchstr\fR(\fBchtype *\fR\fIchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinchnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinchstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype *\fR\fIchstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinchnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype *\fR\fIchstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinchstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype *\fR\fIchstr\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBinchstr()\fR and \fBwinchstr()\fR functions retrieve the character +string (with rendition) starting at the current cursor position of the +\fBstdscr\fR window and window \fIwin\fR, respectively, and ending at the +right margin. The \fBmvinchstr()\fR and \fBmvwinchstr()\fR functions retrieve +the character string located at the position indicated by the \fIx\fR (column) +and \fIy\fR (row) parameters (the former in the \fBstdscr\fR window; the +latter in window \fIwin\fR). +.sp +.LP +The \fBinchnstr()\fR, \fBwinchnstr()\fR, \fBmvinchnstr()\fR, and +\fBmvwinchnstr()\fR functions retrieve at most \fIn\fR characters from the +window \fBstdscr\fR and \fIwin\fR, respectively. The former two functions +retrieve the string, starting at the current cursor position; the latter two +commands retrieve the string, starting at the position specified by the +\fIx\fR and \fIy\fR parameters. +.sp +.LP +All these functions store the retrieved character string in the object pointed +to by \fIchstr\fR. +.sp +.LP +The complete character/attribute pair is retrieved. The character or +attributes can be extracted by performing a bitwise AND on the retrieved +value, using the constants \fBA_CHARTEXT\fR, \fBA_ATTRIBUTES\fR, and +\fBA_COLOR\fR. The character string can also be retrieved without attributes +by using \fBinstr\fR(3XCURSES) set of functions. +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIchstr\fR\fR +.ad +.RS 9n +.rt +Is a pointer to an object that can hold the retrieved character string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 9n +.rt +Is the number of characters not to exceed when retrieving \fIchstr\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 9n +.rt +Is the y (row) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 9n +.rt +Is the x (column) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window in which the string is to be retrieved. +.RE + +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBinch\fR(3XCURSES), \fBinnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/initscr.3xcurses b/usr/src/man/man3xcurses/initscr.3xcurses new file mode 100644 index 0000000000..8d512fd688 --- /dev/null +++ b/usr/src/man/man3xcurses/initscr.3xcurses @@ -0,0 +1,117 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH initscr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +initscr, newterm \- screen initialization functions +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBWINDOW *\fR\fBinitscr\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBSCREEN *\fR\fBnewterm\fR(\fBchar *\fR\fItype\fR, \fBFILE *\fR\fIoutfp\fR, \fBFILE *\fR\fIinfp\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fBtype\fR\fR +.ad +.RS 9n +.rt +Is a string defining the terminal type to be used in place of \fBTERM\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIoutfp\fR\fR +.ad +.RS 9n +.rt +Is a pointer to a file to be used for output to the terminal. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIinfp\fR\fR +.ad +.RS 9n +.rt +Is the pointer to a file to be used for input to the terminal. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBinitscr()\fR function initializes X/Open Curses data structures, +determines the terminal type, and ensures the first call to +\fBrefresh\fR(3XCURSES) clears the screen. +.sp +.LP +The \fBnewterm()\fR function opens a new terminal with each call. It should be +used instead of \fBinitscr()\fR when the program interacts with more than one +terminal. It returns a variable of type \fBSCREEN\fR, which should be used for +later reference to that terminal. Before program termination, \fBendwin()\fR +should be called for each terminal. +.sp +.LP +The only functions that you can call before calling \fBinitscr()\fR or +\fBnewterm()\fR are \fBfilter\fR(3XCURSES), \fBripoffline\fR(3XCURSES), +\fBslk_init\fR(3XCURSES), and \fBuse_env\fR(3XCURSES). +.SH RETURN VALUES +.sp +.LP +On success, the \fBinitscr()\fR function returns a pointer to \fBstdscr\fR; +otherwise, \fBinitscr()\fR does not return. +.sp +.LP +On success, the \fBnewterm()\fR function returns a pointer to the specified +terminal; otherwise, a null pointer is returned. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdel_curterm\fR(3XCURSES), \fBdelscreen\fR(3XCURSES), +\fBdoupdate\fR(3XCURSES), \fBendwin\fR(3XCURSES), \fBfilter\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBslk_attroff\fR(3XCURSES), +\fBuse_env\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/innstr.3xcurses b/usr/src/man/man3xcurses/innstr.3xcurses new file mode 100644 index 0000000000..0040d1c3b4 --- /dev/null +++ b/usr/src/man/man3xcurses/innstr.3xcurses @@ -0,0 +1,194 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH innstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +innstr, instr, mvinnstr, mvinstr, mvwinnstr, mvwinstr, winnstr, winstr \- +retrieve a multibyte character string (without rendition) +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +:#include <curses.h> + +\fBint\fR \fBinnstr\fR(\fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBinstr\fR(\fBchar *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIstr\fR\fR +.ad +.RS 7n +.rt +Is a pointer to an object that can hold the retrieved multibyte character +string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +Is the number of characters not to exceed when retrieving \fIstr\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the string is to be retrieved. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBinstr()\fR and \fBwinstr()\fR functions retrieve a multibyte character +string (without attributes) starting at the current cursor position of the +\fBstdscr\fR window and window \fIwin\fR, respectively, and ending at the right +margin. The \fBmvinstr()\fR and \fBmvwinstr()\fR functions retrieve a multibyte +character string located at the position indicated by the \fIx\fR (column) and +\fIy\fR (row) parameters (the former in the \fBstdscr\fR window; the latter in +window \fIwin\fR). +.sp +.LP +The \fBinnstr()\fR, \fBwinnstr()\fR, \fBmvinnstr()\fR, and \fBmvwinnstr()\fR +functions retrieve at most \fIn\fR characters from the window \fBstdscr\fR and +\fIwin\fR, respectively. The former two functions retrieve the string starting +at the current cursor position; the latter two commands return the string, +starting at the position specified by the \fIx\fR and \fIy\fR parameters. +.sp +.LP +All these functions store the retrieved string in the object pointed to by +\fIstr\fR. They only store complete multibyte characters. If the area pointed +to by \fIstr\fR is not large enough to hold at least one character, these +functions fail. +.sp +.LP +Only the character portion of the character/rendition pair is returned. To +return the complete character/rendition pair, use \fBwinchstr()\fR. +.SH ERRORS +.sp +.ne 2 +.mk +.na +\fB\fBOK\fR\fR +.ad +.RS 7n +.rt +Successful completion. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBERR\fR\fR +.ad +.RS 7n +.rt +An error occurred. +.RE + +.SH USAGE +.sp +.LP +All functions except \fBwinnstr()\fR may be macros. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBinch\fR(3XCURSES), \fBinchstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/innwstr.3xcurses b/usr/src/man/man3xcurses/innwstr.3xcurses new file mode 100644 index 0000000000..594b9b2cbe --- /dev/null +++ b/usr/src/man/man3xcurses/innwstr.3xcurses @@ -0,0 +1,182 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH innwstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +innwstr, inwstr, mvinnwstr, mvinwstr, mvwinnwstr, mvwinwstr, winnwstr, winwstr +\- retrieve a wide character string (without rendition) +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBinnwstr\fR(\fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBinwstr\fR(\fBwchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinnwstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinwstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinnwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBwchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBwchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinnwstr\fR(\fBWINDOW*\fR\fIwin\fR, \fBwchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwstr\fR\fR +.ad +.RS 8n +.rt +Is a pointer to an object that can hold the retrieved multibyte character +string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 8n +.rt +Is the number of characters not to exceed when retrieving \fIwstr\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 8n +.rt +Is the y (row) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 8n +.rt +Is the x (column) coordinate of the starting position of the string to be +retrieved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 8n +.rt +Is a pointer to the window in which the string is to be retrieved. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBinwstr()\fR and \fBwinwstr()\fR functions retrieve a wide character +string (without attributes) starting at the current cursor position of the +\fBstdscr\fR window and window \fIwin\fR, respectively, and ending at the right +margin. The \fBmvinwstr()\fR and \fBmvwinwstr()\fR functions retrieve a wide +character string located at the position indicated by the \fIx\fR (column) and +\fIy\fR (row) parameters (the former in the \fBstdscr\fR window; the latter in +window \fIwin\fR). +.sp +.LP +The \fBinnwstr()\fR, \fBwinnwstr()\fR, \fBmvinnwstr()\fR, and +\fBmvwinnwstr()\fR functions retrieve at most \fIn\fR characters from the +window \fBstdscr\fR and \fIwin\fR, respectively. The former two functions +retrieve the string starting at the current cursor position; the latter two +commands return the string, starting at the position specified by the \fIx\fR +and \fIy\fR parameters. +.sp +.LP +All these functions store the retrieved string in the object pointed to by +\fIwstr\fR. They only store complete wide characters. If the area pointed to by +\fIwstr\fR is not large enough to hold at least one character, these functions +fail. +.sp +.LP +Only the character portion of the character/rendition pair is returned. To +return the complete character/rendition pair, use \fBwin_wchstr\fR(3XCURSES). +.SH RETURN VALUES +.sp +.LP +On success, the \fBinwstr()\fR, \fBmvinwstr()\fR, \fBmvwinwstr()\fR, and +\fBwinwstr()\fR functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.sp +.LP +On success, the \fBinnwstr()\fR, \fBmvinnwstr()\fR, \fBmvwinnwstr()\fR, and +\fBwinnwstr()\fR functions return the number of characters read into the +string. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBin_wch\fR(3XCURSES), \fBin_wchnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/ins_nwstr.3xcurses b/usr/src/man/man3xcurses/ins_nwstr.3xcurses new file mode 100644 index 0000000000..4de33bb3d2 --- /dev/null +++ b/usr/src/man/man3xcurses/ins_nwstr.3xcurses @@ -0,0 +1,179 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ins_nwstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +ins_nwstr, ins_wstr, mvins_nwstr, mvins_wstr, mvwins_nwstr, mvwins_wstr, +wins_nwstr, wins_wstr \- insert a wide character string +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBins_nwstr\fR(\fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBins_wstr\fR(\fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvins_nwstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvins_wstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwins_nwstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwins_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwins_nwstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst wchar_t *\fR\fIwstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwins_wstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst wchar_t *\fR\fIwstr\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwstr\fR\fR +.ad +.RS 8n +.rt +Is a pointer to the string to be inserted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 8n +.rt +Is the number of characters not to exceed when inserting \fIwstr\fR. If +\fIn\fR is less than 1, the entire string is inserted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 8n +.rt +Is the y (row) coordinate of the starting position of the string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 8n +.rt +Is the x (column) coordinate of the starting position of the string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 8n +.rt +Is a pointer to the window in which the string is to be inserted. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBins_wstr()\fR function inserts \fIwstr\fR at the current cursor +position of the \fBstdscr\fR window. The \fBwins_wstr()\fR function performs +the identical action, but in window \fIwin\fR. The \fBmvins_wstr()\fR and +\fBmvwins_wstr()\fR functions insert \fIwstr\fR string at the starting position +indicated by the \fIx\fR (column) and \fIy\fR (row) parameters (the former in +the \fBstdscr\fR window; the latter in window \fIwin\fR). +.sp +.LP +The \fBins_nwstr()\fR, \fBwins_nwstr()\fR, \fBmvins_nwstr()\fR, and +\fBmvwins_nwstr()\fR functions insert \fIn\fR characters to the window or as +many as will fit on the line. If \fIn\fR is less than 1, the entire string is +inserted or as much of it as fits on the line. The former two functions place +the string at the current cursor position; the latter two commands use the +position specified by the \fIx\fR and \fIy\fR parameters. +.sp +.LP +All characters to the right of inserted characters are moved to the right. +Characters that don't fit on the current line are discarded. The cursor is left +at the point of insertion. +.sp +.LP +If a character in \fIwstr\fR is a newline, carriage return, backspace, or tab, +the cursor is moved appropriately. The cursor is moved to the next tab stop +for each tab character (by default, tabs are eight characters apart). If the +character is a control character other than those previously mentioned, the +character is inserted using \fB^\fR\fIx\fR notation, where \fIx\fR is a +printable character. \fBclrtoeol\fR(3XCURSES) is automatically done before a +newline. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return +\fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wchnstr\fR(3XCURSES), \fBaddnwstr\fR(3XCURSES), +\fBclrtoeol\fR(3XCURSES), \fBins_wch\fR(3XCURSES), \fBinsnstr\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/ins_wch.3xcurses b/usr/src/man/man3xcurses/ins_wch.3xcurses new file mode 100644 index 0000000000..10c9bc2e77 --- /dev/null +++ b/usr/src/man/man3xcurses/ins_wch.3xcurses @@ -0,0 +1,131 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ins_wch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +ins_wch, wins_wch, mvins_wch, mvwins_wch \- insert a complex character +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBins_wch\fR(\fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvins_wch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwins_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwins_wch\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst cchar_t *\fR\fIwch\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 7n +.rt +Is the complex character to be inserted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the position of the character. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the position of the character. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the character is to be inserted. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBins_wch()\fR function inserts the complex character \fIwch\fR at the +current cursor position of the \fBstdscr\fR window. The \fBwins_wch()\fR +function performs the identical action but in window \fIwin\fR. The +\fBmvins_wch()\fR and \fBmvwins_wch()\fR functions insert the character at the +position indicated by the \fIx\fR (column) and \fIy\fR (row) parameters (the +former in the \fBstdscr\fR window; the latter in window \fIwin\fR). The cursor +position does not change. +.sp +.LP +All characters to the right of the inserted character are moved right one +character. The last character on the line is deleted. +.sp +.LP +Insertions and deletions occur at the character level. The cursor is adjusted +to the first column of the character prior to the operation. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBins_nwstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/insch.3xcurses b/usr/src/man/man3xcurses/insch.3xcurses new file mode 100644 index 0000000000..881623da2c --- /dev/null +++ b/usr/src/man/man3xcurses/insch.3xcurses @@ -0,0 +1,131 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH insch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +insch, winsch, mvinsch, mvwinsch \- insert a character +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBinsch\fR(\fBchtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinsch\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinsch\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinsch\fR(\fBWINDOW *\fR\fIwin\fR, \fBchtype\fR \fIch\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 7n +.rt +Is the character to be inserted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the position of the character. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the position of the character. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the character is to be inserted. +.RE + +.SH DESCRIPTION +.sp +.LP +These functions insert the character and rendition from \fIch\fR into the +current or specified window at the current or specified position. +.sp +.LP +These functions do not perform wrapping and do not advance the cursor position. +These functions perform special-character processing, with the exception that +if a newline is inserted into the last line of a window and scrolling is not +enabled, the behavior is unspecified. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, these functions return \fBOK\fR. Otherwise, they +return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +These functions are only guaranteed to operate reliably on character sets in +which each character fits into a single byte, whose attributes can be expressed +using only constants with the \fBA_\fR prefix. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBins_wch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/insdelln.3xcurses b/usr/src/man/man3xcurses/insdelln.3xcurses new file mode 100644 index 0000000000..af0b0c25cb --- /dev/null +++ b/usr/src/man/man3xcurses/insdelln.3xcurses @@ -0,0 +1,91 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH insdelln 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +insdelln, winsdelln \- insert/delete lines to/from the window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBinsdelln\fR(\fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinsdelln\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIn\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +Is the number of lines to insert or delete (positive \fIn\fR inserts; negative +\fIn\fR deletes). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which to insert or delete a line. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBinsdelln()\fR and \fBwinsdelln()\fR functions insert or delete blank +lines in \fBstdscr\fR or \fIwin\fR, respectively. When \fIn\fR is positive, +\fIn\fR lines are added before the current line and the bottom \fIn\fR lines +are lost; when \fIn\fR is negative, \fIn\fR lines are deleted starting with +the current line, the remaining lines are moved up, and the bottom \fIn\fR +lines are cleared. The position of the cursor does not change. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdeleteln\fR(3XCURSES), \fBinsertln\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/insertln.3xcurses b/usr/src/man/man3xcurses/insertln.3xcurses new file mode 100644 index 0000000000..780949b33f --- /dev/null +++ b/usr/src/man/man3xcurses/insertln.3xcurses @@ -0,0 +1,77 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH insertln 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +insertln, winsertln \- insert a line in a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBinsertln\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinsertln\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which to insert the line. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBinsertln()\fR and \fBwinsertln()\fR functions insert a blank line before +the current line in \fBstdscr\fR or \fIwin\fR, respectively. The new line +becomes the current line. The current line and all lines after it in the +window are moved down one line. The bottom line in the window is discarded. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBbkgdset\fR(3XCURSES), \fBdeleteln\fR(3XCURSES), \fBinsdelln\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/insnstr.3xcurses b/usr/src/man/man3xcurses/insnstr.3xcurses new file mode 100644 index 0000000000..2dc7f2a2b3 --- /dev/null +++ b/usr/src/man/man3xcurses/insnstr.3xcurses @@ -0,0 +1,178 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH insnstr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +insnstr, insstr, mvinsnstr, mvinsstr, mvwinsnstr, mvwinsstr, winsnstr, winsstr +\- insert a multibyte character string +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBinsnstr\fR(\fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBinsstr\fR(\fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinsnstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvinsstr\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinsnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwinsstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinsnstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst char *\fR\fIstr\fR, \fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBwinsstr\fR(\fBWINDOW *\fR\fIwin\fR, \fBconst char *\fR\fIstr\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIstr\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the string to be inserted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +Is the number of characters not to exceed when inserting \fIstr\fR. If +\fIn\fR is less than 1, the entire string is inserted. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the starting position of the string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the starting position of the string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the string is to be inserted. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBinsstr()\fR function inserts \fIstr\fR at the current cursor position +of the \fBstdscr\fR window. The \fBwinsstr()\fR function performs the identical +action, but in window \fIwin\fR. The \fBmvinsstr()\fR and \fBmvwinsstr()\fR +functions insert the character string at the starting position indicated by +the \fIx\fR (column) and \fIy\fR (row) parameters (the former to the +\fBstdscr\fR window; the latter to window \fIwin\fR). +.sp +.LP +The \fBinsnstr()\fR, \fBwinsnstr()\fR, \fBmvinsnstr()\fR, and +\fBmvwinsnstr()\fR functions insert \fIn\fR characters to the window or as +many as will fit on the line. If \fIn\fR is less than 1, the entire string is +inserted or as much of it as fits on the line. The former two functions place +the string at the current cursor position; the latter two commands use the +position specified by the \fIx\fR and \fIy\fR parameters. +.sp +.LP +All characters to the right of inserted characters are moved to the right. +Characters that don't fit on the current line are discarded. The cursor is left +at the point of insertion. +.sp +.LP +If a character in \fIstr\fR is a newline, carriage return, backspace, or tab, +the cursor is moved appropriately. The cursor is moved to the next tab stop +for each tab character (by default, tabs are eight characters apart). If the +character is a control character other than those previously mentioned, the +character is inserted using \fB^\fR\fIx\fR notation, where \fIx\fR is a +printable character. \fBclrtoeol\fR(3XCURSES) is automatically done before a +newline. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddchstr\fR(3XCURSES), \fBaddstr\fR(3XCURSES), \fBclrtoeol\fR(3XCURSES), +\fBins_nwstr\fR(3XCURSES), \fBinsch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/intrflush.3xcurses b/usr/src/man/man3xcurses/intrflush.3xcurses new file mode 100644 index 0000000000..caf5568354 --- /dev/null +++ b/usr/src/man/man3xcurses/intrflush.3xcurses @@ -0,0 +1,88 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH intrflush 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +intrflush \- enable or disable flush on interrupt +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBintrflush\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is ignored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBintrflush()\fR function specifies whether pressing an interrupt key +(interrupt, suspend, or quit) will flush the input buffer associated with the +current screen. If the value of \fIbf\fR is \fBTRUE\fR, then flushing of the +output buffer associated with the current screen will occur when an interrupt +key (interrupt, suspend, or quit) is pressed.If the value of \fIbf\fR is +\fBFALSE\fR, then no flushing of the buffer will occur when an interrupt key is +pressed. The default for the option is inherited from the display driver +settings. The \fIwin\fR argument is ignored. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, \fBintrflush()\fR returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBflushinp\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBqiflush\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/is_linetouched.3xcurses b/usr/src/man/man3xcurses/is_linetouched.3xcurses new file mode 100644 index 0000000000..2339c0dc43 --- /dev/null +++ b/usr/src/man/man3xcurses/is_linetouched.3xcurses @@ -0,0 +1,191 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH is_linetouched 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +is_linetouched, is_wintouched, touchline, touchwin, untouchwin, wtouchln \- +control window refresh +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBbool\fR \fBis_linetouched\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIline\fR); +.fi + +.LP +.nf +\fBbool\fR \fBis_wintouched\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBtouchline\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIstart\fR, \fBint\fR \fIcount\fR); +.fi + +.LP +.nf +\fBint\fR \fBtouchwin\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBuntouchwin\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBwtouchln\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIn\fR, \fBint\fR \fIchanged\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 11n +.rt +Is a pointer to the window in which the refresh is to be controlled or +monitored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBline\fR\fR +.ad +.RS 11n +.rt +Is the line to be checked for change since refresh. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIstart\fR\fR +.ad +.RS 11n +.rt +Is the starting line number of the portion of the window to make appear +changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcount\fR\fR +.ad +.RS 11n +.rt +Is the number of lines in the window to mark as changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 11n +.rt +Is the starting line number of the portion of the window to make appear changed +or not changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 11n +.rt +Is the number of lines in the window to mark as changed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIchanged\fR\fR +.ad +.RS 11n +.rt +Is a flag indicating whether to make lines look changed (0) or not changed (1). +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBtouchwin()\fR function marks the entire window as dirty. This makes it +appear to X/Open Curses as if the whole window has been changed, thus causing +the entire window to be rewritten with the next call to +\fBrefresh\fR(3XCURSES). This is sometimes necessary when using overlapping +windows; the change to one window will not be reflected in the other and, hence +will not be recorded. +.sp +.LP +The \fBtouchline()\fR function marks as dirty a portion of the window starting +at line \fIstart\fR and continuing for \fIcount\fR lines instead of the entire +window. Consequently, that portion of the window is updated with the next call +to \fBrefresh()\fR. +.sp +.LP +The \fBuntouchwin()\fR function marks all lines in the window as unchanged +since the last refresh, ensuring that it is not updated. +.sp +.LP +The \fBwtouchln()\fR function marks \fIn\fR lines starting at line \fIy\fR as +either changed (\fIchanged\fR=1) or unchanged (\fIchanged\fR=0) since the last +refresh. +.sp +.LP +To find out which lines or windows have been changed since the last refresh, +use the \fBis_linetouched()\fR and \fBis_wintouched()\fR functions, +respectively. These return \fBTRUE\fR if the specified line or window have been +changed since the last call to \fBrefresh()\fR or \fBFALSE\fR if no changes +have been made. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/keyname.3xcurses b/usr/src/man/man3xcurses/keyname.3xcurses new file mode 100644 index 0000000000..2bf497c2f7 --- /dev/null +++ b/usr/src/man/man3xcurses/keyname.3xcurses @@ -0,0 +1,116 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH keyname 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +keyname, key_name \- return character string used as key name +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBchar *\fR\fBkeyname\fR(\fBint\fR \fIc\fR); +.fi + +.LP +.nf +\fBchar *\fR\fBkey_name\fR(\fBwchar_t\fR \fIwc\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIc\fR\fR +.ad +.RS 6n +.rt +Is an 8 bit-character or a key code. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fBwc\fR\fR +.ad +.RS 6n +.rt +Is a wide character key name. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBkeyname()\fR function returns a string pointer to the key name. Make a +duplicate copy of the returned string if you plan to modify it. +.sp +.LP +The \fBkey_name()\fR function is similar except that it accepts a wide +character key name. +.sp +.LP +The following table shows the format of the key name based on the input. +.sp + +.sp +.TS +tab() box; +lw(1.99i) lw(3.51i) +lw(1.99i) lw(3.51i) +. +\fBInput\fR\fBFormat of Key Name\fR +Visible characterThe same character +Control character\fB^\fR\fIX\fR +Meta-character (\fBkeyname()\fR only)\fBM-\fR\fIX\fR +T{ +Key value defined in \fB<curses.h>\fR (\fBkeyname()\fR only) +T}\fBKEY_\fR\fIname\fR +None of the above\fBUNKNOWN KEY\fR +.TE + +.sp +.LP +In the preceding table, \fIX\fR can be either a visible character with the high +bit cleared or a control character. +.SH RETURN VALUES +.sp +.LP +On success, these functions return a pointer to the string used as the key's +name. Otherwise, they return a null pointer. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBmeta\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/keypad.3xcurses b/usr/src/man/man3xcurses/keypad.3xcurses new file mode 100644 index 0000000000..3fb8b509ee --- /dev/null +++ b/usr/src/man/man3xcurses/keypad.3xcurses @@ -0,0 +1,262 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH keypad 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +keypad \- enable/disable keypad handling +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBkeypad\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which to enable/disable keypad handling. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBkeypad()\fR function controls keypad translation. If \fIbf\fR is +\fBTRUE\fR, keypad translation is enabled. If \fIbf\fR is \fBFALSE\fR, keypad +translation is disabled. The initial state is \fBFALSE\fR. +.sp +.LP +This function affects the behavior of any function that provides keyboard +input. +.sp +.LP +If the terminal in use requires a command to enable it to transmit distinctive +codes when a function key is pressed, then after keypad translation is first +enabled, the implementation transmits this command to the terminal before an +affected input function tries to read any characters from that terminal. +.sp +.LP +The Curses input model provides the following ways to obtain input from the +keyboard: +.SS "Keypad processing" +.sp +.LP +The application can enable or disable keypad translation by calling +\fBkeypad()\fR. When translation is enabled, Curses attempts to translate a +sequence of terminal input that represents the pressing of a function into a +single key code. When translation is disabled, Curses passes terminal input to +the application without such translation, and any interpretation of the input +as representing the pressing of a keypad key must be done by the application. +.sp +.LP +The complete set of key codes for keypad keys that Curses can process is +specified by the constants defined in <\fBcurses.h\fR> whose names begin with +"\fBKEY_\fR". Each terminal type described in the \fBterminfo\fR database may +support some or all of these key codes. The \fBterminfo\fR database specifies +the sequence of input characters from the terminal type that correspond to each +key code. +.sp +.LP +The Curses inplementation cannot translate keypad keys on terminals where +pressing the keys does not transmit a unique sequence. +.sp +.LP +When translation is enabled and a character that could be the beginning of a +function key (such as escape) is received, Curses notes the time and begins +accumulating characters. If Curses receives additional characters that +represent the processing of a keypad key within an unspecified interval from +the time the character was received, then Curses converts this input to a key +code for presentation to the application. If such characters are not received +during this interval, translation of this input does not occur and the +individual characters are presented to the application separately. (Because +Curses waits for this interval to accumulate a key code, many terminals +experience a delay between the time a user presses the escape key and the time +the escape key is returned to the application.) +.sp +.LP +In addition, No Timeout Mode provides that in any case where Curses has +received part of a function key sequence, it waits indefinitely for the +complete key sequence. The "unspecified interval" in the previous paragraph +becomes infinite in No Timeout Mode. No Timeout Mode allows the use of function +keys over slow communication lines. No Timeout Mode lets the user type the +individual characters of a function key sequence, but also delays application +response when the user types a character (not a function key) that begins a +function key sequence. For this reason, in No Timeout Mode many terminals will +appear to hang between the time a user presses the escape key and the time +another key is pressed. No Timeout Mode is switchable by calling +\fBnotimeout\fR(3XCURSES). +.sp +.LP +If any special characters (<backspace>, <carriage return>, <newline>, <tab>) +are defined or redefined to be characters that are members of a function key +sequence, then Curses will be unable to recognize and translate those function +keys. +.sp +.LP +Several of the modes discussed below are described in terms of availability of +input. If keypad translation is enabled, then input is not available once +Curses has begun receiving a keypad sequence until the sequence is completely +received or the interval has elapsed. +.SS "Input Mode" +.sp +.LP +The following four mutually-specific Curses modes let the application control +the effect of flow-control characters, the interrupt character, the erase +character, and the kill character: +.sp + +.sp +.TS +tab() box; +cw(1.44i) cw(4.06i) +lw(1.44i) lw(4.06i) +. + Input Mode Effect +Cooked ModeT{ + This achieves normal line-at-a-time processing with all special characters handled outside the application. This achieves the same effect as canonical-mode input processing. The state of the \fBISIG\fR and \fBIXON\fR flags are not changed upon entering this mode by calling \fBnocbreak\fR(3XCURSES), and are set upon entering this mode by calling \fBnoraw\fR(3XCURSES).Erase and kill characters are supported from any supported locale, no matter the width of the character. +T} +\fBcbreak\fR ModeT{ +Characters typed by the user are immediately available to the application and Curses does not perform special processing on either the erase character or the kill character. An application can set \fBcbreak\fR mode to do its own line editing but to let the abort character be used to abort the task. This mode achieves the same effect as non-canonical-mode, Case B input processing (with MIN set to 1 and ICRNL cleared.) The state of the \fBISIG\fR and \fBIXON\fR flags are not changed upon entering this mode. +T} +Half-Delay ModeT{ + The effect is the same as \fBcbreak\fR, except that input functions wait until a character is available or an interval defined by the application elapses, whichever comes first. This mode achieves the same effect as non-canonical-mode, Case C input processing (with TIME set to the value specified by the application.) The state of the \fBISIG\fR and \fBIXON\fR flags are not changed upon entering this mode. +T} +Raw ModeT{ +Raw mode gives the application maximum control over terminal input. The application sees each character as it is typed. This achieves the same effect as non-canonical mode, Case D input processing. The \fBISIG\fR and \fBIXON\fR flags are cleared upon entering this mode. +T} +.TE + +.sp +.LP +The terminal interface settings are reported when the process calls +\fBinitscr\fR(3XCURSES) or \fBnewterm\fR(3XCURSES) to initialize Curses and +restores these settings when \fBendwin\fR(3XCURSES) is called. The initial +input mode for Curses operations is especially unless Enhanced Curses +compliance, in which the initial mode is \fBcbreak\fR mode, is supported. +.sp +.LP +The behavior of the \fBBREAK\fR key depends on other bits in the display driver +that are not set by Curses. +.SS "Delay Mode" +.sp +.LP +Two mutually-exclusive delay modes specify how quickly certain Curses functions +return to the application when there is no terminal input waiting when the +function is called: +.sp +.ne 2 +.mk +.na +\fBNo Delay\fR +.ad +.RS 12n +.rt +The function fails. +.RE + +.sp +.ne 2 +.mk +.na +\fBDelay\fR +.ad +.RS 12n +.rt + The application waits until text is passed through to the application. If +\fBcbreak\fR or Raw Mode is set, this is after one character. Otherwise, this +is after the first <newline> character, end-of-line character, or end-of-file +character. +.RE + +.sp +.LP +The effect of No Delay Mode on function key processing is unspecified. +.SS "Echo processing" +.sp +.LP +Echo mode determines whether Curses echoes typed characters to the screen. The +effect of Echo mode is analogous to the effect of the \fBECHO\fR flag in the +local mode field of the \fBtermios\fR structure associated with the terminal +device connected to the window. However, Curses always clears the \fBECHO\fR +flag when invoked, to inhibit the operating system from performing echoing. The +method of echoing characters is not identical to the operating system's method +of echoing characters, because Curses performs additional processing of +terminal input. +.sp +.LP +If in Echo mode, Curses performs 's's own echoing. Any visible input character +is stored in the current or specified window by the input function that the +application called, at that window's cursor position, as though +\fBaddch\fR(3XCURSES) were called, with all consequent effects such as cursor +movement and wrapping. +.sp +.LP +If not in Echo mode, any echoing of input must be performed by the application. +Applications often perform their own echoing in a controlled area of the +screen, or do not echo at all, so they disable Echo mode. +.sp +.LP +It may not be possible to turn off echo processing for synchronous and +networked asynchronous terminals because echo processing is done directly by +the terminals. Applications running on such terminals should be aware that any +characters typed will appear on the screen at wherever the cursor is +positioned. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, the \fBkeypad()\fR function returns \fBOK\fR. +Otherwise, it returns \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBendwin\fR(3XCURSES), \fBgetch\fR(3XCURSES), +\fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewterm\fR(3XCURSES), +\fBnocbreak\fR(3XCURSES), \fBnoraw\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/libcurses.3xcurses b/usr/src/man/man3xcurses/libcurses.3xcurses new file mode 100644 index 0000000000..8a01587151 --- /dev/null +++ b/usr/src/man/man3xcurses/libcurses.3xcurses @@ -0,0 +1,312 @@ +'\" te +.\" Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH libcurses 3XCURSES "20 May 2003" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +libcurses \- X/Open Curses library +.SH SYNOPSIS +.LP +.nf +cc [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR \fB/usr/xpg4/include\fR \fB-L\fR \fB/usr/xpg4/lib\fR \e +\fB-R\fR \fB/usr/xpg4/lib\fR \fB-lcurses\fR [ \fIlibrary\fR... ] +.fi + +.LP +.nf +c89 [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> +.fi + +.SH DESCRIPTION +.sp +.LP +Functions in this library provide a terminal-independent method of updating +character screens with reasonable optimization, conforming to X/Open Curses, +Issue 4, Version 2. +.SH INTERFACES +.sp +.LP +The shared object \fBlibcurses.so.2\fR provides the public interfaces defined +below. See \fBIntro\fR(3) for additional information on shared object +interfaces. +.sp + +.sp +.TS +tab(); +lw(2.75i) lw(2.75i) +lw(2.75i) lw(2.75i) +. +\fBCOLORS\fR\fBCOLOR_PAIR\fR +\fBCOLOR_PAIRS\fR\fBCOLS\fR +\fBLINES\fR\fBPAIR_NUMBER\fR +\fBadd_wch\fR\fBadd_wchnstr\fR +\fBadd_wchstr\fR\fBaddch\fR +\fBaddchnstr\fR\fBaddchstr\fR +\fBaddnstr\fR\fBaddnwstr\fR +\fBaddstr\fR\fBaddwstr\fR +\fBattr_get\fR\fBattr_off\fR +\fBattr_on\fR\fBattr_set\fR +\fBattroff\fR\fBattron\fR +\fBattrset\fR\fBbaudrate\fR +\fBbeep\fR\fBbkgd\fR +\fBbkgdset\fR\fBbkgrnd\fR +\fBbkgrndset\fR\fBborder\fR +\fBborder_set\fR\fBbox\fR +\fBbox_set\fR\fBcan_change_color\fR +\fBcbreak\fR\fBchgat\fR +\fBclear\fR\fBclearok\fR +\fBclrtobot\fR\fBclrtoeol\fR +\fBcolor_content\fR\fBcolor_set\fR +\fBcopywin\fR\fBcur_term\fR +\fBcurs_set\fR\fBcurscr\fR +\fBdef_prog_mode\fR\fBdef_shell_mode\fR +\fBdel_curterm\fR\fBdelay_output\fR +\fBdelch\fR\fBdeleteln\fR +\fBdelscreen\fR\fBdelwin\fR +\fBderwin\fR\fBdoupdate\fR +\fBdupwin\fR\fBecho\fR +\fBecho_wchar\fR\fBechochar\fR +\fBendwin\fR\fBerase\fR +\fBerasechar\fR\fBerasewchar\fR +\fBfilter\fR\fBflash\fR +\fBflushinp\fR\fBget_wch\fR +\fBget_wstr\fR\fBgetbkgd\fR +\fBgetbkgrnd\fR\fBgetcchar\fR +\fBgetch\fR\fBgetn_wstr\fR +\fBgetnstr\fR\fBgetstr\fR +\fBgetwin\fR\fBhalfdelay\fR +\fBhas_colors\fR\fBhas_ic\fR +\fBhas_il\fR\fBhline\fR +\fBhline_set\fR\fBidcok\fR +\fBidlok\fR\fBimmedok\fR +\fBin_wch\fR\fBin_wchnstr\fR +\fBin_wchstr\fR\fBinch\fR +\fBinchnstr\fR\fBinchstr\fR +\fBinit_color\fR\fBinit_pair\fR +\fBinitscr\fR\fBinnstr\fR +\fBinnwstr\fR\fBins_nwstr\fR +\fBins_wch\fR\fBins_wstr\fR +\fBinsch\fR\fBinsdelln\fR +\fBinsertln\fR\fBinsnstr\fR +\fBinsstr\fR\fBinstr\fR +\fBintrflush\fR\fBinwstr\fR +\fBis_linetouched\fR\fBis_wintouched\fR +\fBisendwin\fR\fBkey_name\fR +\fBkeyname\fR\fBkeypad\fR +\fBkillchar\fR\fBkillwchar\fR +\fBleaveok\fR\fBlongname\fR +\fBmeta\fR\fBmove\fR +\fBmvadd_wch\fR\fBmvadd_wchnstr\fR +\fBmvadd_wchstr\fR\fBmvaddch\fR +\fBmvaddchnstr\fR\fBmvaddchstr\fR +\fBmvaddnstr\fR\fBmvaddnwstr\fR +\fBmvaddstr\fR\fBmvaddwstr\fR +\fBmvchgat\fR\fBmvcur\fR +\fBmvdelch\fR\fBmvderwin\fR +\fBmvget_wch\fR\fBmvget_wstr\fR +\fBmvgetch\fR\fBmvgetn_wstr\fR +\fBmvgetnstr\fR\fBmvgetstr\fR +\fBmvhline\fR\fBmvhline_set\fR +\fBmvin_wch\fR\fBmvin_wchnstr\fR +\fBmvin_wchstr\fR\fBmvinch\fR +\fBmvinchnstr\fR\fBmvinchstr\fR +\fBmvinnstr\fR\fBmvinnwstr\fR +\fBmvins_nwstr\fR\fBmvins_wch\fR +\fBmvins_wstr\fR\fBmvinsch\fR +\fBmvinsnstr\fR\fBmvinsstr\fR +\fBmvinstr\fR\fBmvinwstr\fR +\fBmvprintw\fR\fBmvscanw\fR +\fBmvvline\fR\fBmvvline_set\fR +\fBmvwadd_wch\fR\fBmvwadd_wchnstr\fR +\fBmvwadd_wchstr\fR\fBmvwaddch\fR +\fBmvwaddchnstr\fR\fBmvwaddchstr\fR +\fBmvwaddnstr\fR\fBmvwaddnwstr\fR +\fBmvwaddstr\fR\fBmvwaddwstr\fR +\fBmvwchgat\fR\fBmvwdelch\fR +\fBmvwget_wch\fR\fBmvwget_wstr\fR +\fBmvwgetch\fR\fBmvwgetn_wstr\fR +\fBmvwgetnstr\fR\fBmvwgetstr\fR +\fBmvwhline\fR\fBmvwhline_set\fR +\fBmvwin\fR\fBmvwin_wch\fR +\fBmvwin_wchnstr\fR\fBmvwin_wchstr\fR +\fBmvwinch\fR\fBmvwinchnstr\fR +\fBmvwinchstr\fR\fBmvwinnstr\fR +\fBmvwinnwstr\fR\fBmvwins_nwstr\fR +\fBmvwins_wch\fR\fBmvwins_wstr\fR +\fBmvwinsch\fR\fBmvwinsnstr\fR +\fBmvwinsstr\fR\fBmvwinstr\fR +\fBmvwinwstr\fR\fBmvwprintw\fR +\fBmvwscanw\fR\fBmvwvline\fR +\fBmvwvline_set\fR\fBnapms\fR +\fBnewpad\fR\fBnewterm\fR +\fBnewwin\fR\fBnl\fR +\fBnocbreak\fR\fBnodelay\fR +\fBnoecho\fR\fBnonl\fR +\fBnoqiflush\fR\fBnoraw\fR +\fBnotimeout\fR\fBoverlay\fR +\fBoverwrite\fR\fBpair_content\fR +\fBpecho_wchar\fR\fBpechochar\fR +\fBpnoutrefresh\fR\fBprefresh\fR +\fBprintw\fR\fBputp\fR +\fBputwin\fR\fBqiflush\fR +\fBraw\fR\fBredrawwin\fR +\fBrefresh\fR\fBreset_prog_mode\fR +\fBreset_shell_mode\fR\fBresetty\fR +\fBrestartterm\fR\fBripoffline\fR +\fBsavetty\fR\fBscanw\fR +\fBscr_dump\fR\fBscr_init\fR +\fBscr_restore\fR\fBscr_set\fR +\fBscrl\fR\fBscroll\fR +\fBscrollok\fR\fBset_curterm\fR +\fBset_term\fR\fBsetcchar\fR +\fBsetscrreg\fR\fBsetupterm\fR +\fBslk_attr_off\fR\fBslk_attr_on\fR +\fBslk_attr_set\fR\fBslk_attroff\fR +\fBslk_attron\fR\fBslk_attrset\fR +\fBslk_clear\fR\fBslk_color\fR +\fBslk_init\fR\fBslk_label\fR +\fBslk_noutrefresh\fR\fBslk_refresh\fR +\fBslk_restore\fR\fBslk_set\fR +\fBslk_touch\fR\fBslk_wset\fR +\fBstandend\fR\fBstandout\fR +\fBstart_color\fR\fBstdscr\fR +\fBsubpad\fR\fBsubwin\fR +\fBsyncok\fR\fBterm_attrs\fR +\fBtermattrs\fR\fBtermname\fR +\fBtgetent\fR\fBtgetflag\fR +\fBtgetnum\fR\fBtgetstr\fR +\fBtgoto\fR\fBtigetflag\fR +\fBtigetnum\fR\fBtigetstr\fR +\fBtimeout\fR\fBtouchline\fR +\fBtouchwin\fR\fBtparm\fR +\fBtputs\fR\fBtypeahead\fR +\fBunctrl\fR\fBunget_wch\fR +\fBungetch\fR\fBuntouchwin\fR +\fBuse_env\fR\fBvid_attr\fR +\fBvid_puts\fR\fBvidattr\fR +\fBvidputs\fR\fBvline\fR +\fBvline_set\fR\fBvw_printw\fR +\fBvw_scanw\fR\fBvwprintw\fR +\fBvwscanw\fR\fBwadd_wch\fR +\fBwadd_wchnstr\fR\fBwadd_wchstr\fR +\fBwaddch\fR\fBwaddchnstr\fR +\fBwaddchstr\fR\fBwaddnstr\fR +\fBwaddnwstr\fR\fBwaddstr\fR +\fBwaddwstr\fR\fBwattr_get\fR +\fBwattr_off\fR\fBwattr_on\fR +\fBwattr_set\fR\fBwattroff\fR +\fBwattron\fR\fBwattrset\fR +\fBwbkgd\fR\fBwbkgdset\fR +\fBwbkgrnd\fR\fBwbkgrndset\fR +\fBwborder\fR\fBwborder_set\fR +\fBwchgat\fR\fBwclear\fR +\fBwclrtobot\fR\fBwclrtoeol\fR +\fBwcolor_set\fR\fBwcursyncup\fR +\fBwdelch\fR\fBwdeleteln\fR +\fBwecho_wchar\fR\fBwechochar\fR +\fBwerase\fR\fBwget_wch\fR +\fBwget_wstr\fR\fBwgetbkgrnd\fR +\fBwgetch\fR\fBwgetn_wstr\fR +\fBwgetnstr\fR\fBwgetstr\fR +\fBwhline\fR\fBwhline_set\fR +\fBwin_wch\fR\fBwin_wchnstr\fR +\fBwin_wchstr\fR\fBwinch\fR +\fBwinchnstr\fR\fBwinchstr\fR +\fBwinnstr\fR\fBwinnwstr\fR +\fBwins_nwstr\fR\fBwins_wch\fR +\fBwins_wstr\fR\fBwinsch\fR +\fBwinsdelln\fR\fBwinsertln\fR +\fBwinsnstr\fR\fBwinsstr\fR +\fBwinstr\fR\fBwinwstr\fR +\fBwmove\fR\fBwnoutrefresh\fR +\fBwprintw\fR\fBwredrawln\fR +\fBwrefresh\fR\fBwscanw\fR +\fBwscrl\fR\fBwsetscrreg\fR +\fBwstandend\fR\fBwstandout\fR +\fBwsyncdown\fR\fBwsyncup\fR +\fBwtimeout\fR\fBwtouchln\fR +\fBwunctrl\fR\fBwvline\fR +\fBwvline_set\fR +.TE + +.SH FILES +.sp +.ne 2 +.mk +.na +\fB\fB/usr/xpg4/lib/libcurses.so.1\fR\fR +.ad +.sp .6 +.RS 4n +shared object for backward compatibility +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/xpg4/lib/libcurses.so.2\fR\fR +.ad +.sp .6 +.RS 4n +shared object +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/xpg4/lib/64/libcurses.so.1\fR\fR +.ad +.sp .6 +.RS 4n +64-bit shared object for backward compatibility +.RE + +.sp +.ne 2 +.mk +.na +\fB\fB/usr/xpg4/lib/64/libcurses.so.2\fR\fR +.ad +.sp .6 +.RS 4n +64-bit shared object +.RE + +.SH NOTES +.sp +.LP +The \fBlibcurses.so.1\fR listed above is an earlier shared object that provides +the previous version of the X/Open Curses library (Issue 4). There is no binary +compatiblity between \fBlibcurses.so.1\fR and \fBlibcurses.so.2\fR. This file +is provided for backwards compatiblity and will be removed in a future Solaris +release. There is no plan to fix any of its defects. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBIntro\fR(3), \fBcurses\fR(3XCURSES), \fBlibcurses\fR(3LIB), +\fBlibcurses\fR(3LIBUCB), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/longname.3xcurses b/usr/src/man/man3xcurses/longname.3xcurses new file mode 100644 index 0000000000..ebb4012c9c --- /dev/null +++ b/usr/src/man/man3xcurses/longname.3xcurses @@ -0,0 +1,63 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH longname 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +longname \- return full terminal type name +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBconst char *\fR\fBlongname\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBlongname()\fR function returns a pointer to a static area containing a +verbose description (128 characters or fewer) of the terminal. The area is +defined after calls to \fBinitscr\fR(3XCURSES), \fBnewterm\fR(3XCURSES), or +\fBsetupterm\fR(3XCURSES). The value should be saved if \fBlongname()\fR is +going to be used with multiple terminals since it will be overwritten with a +new value after each call to \fBnewterm()\fR or \fB setupterm()\fR. +.SH RETURN VALUES +.sp +.LP +On success, the \fBlongname()\fR function returns a pointer to a verbose +description of the terminal. Otherwise, it returns a null pointer. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBnewterm\fR(3XCURSES), +\fBsetupterm\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/meta.3xcurses b/usr/src/man/man3xcurses/meta.3xcurses new file mode 100644 index 0000000000..02bae5bcb2 --- /dev/null +++ b/usr/src/man/man3xcurses/meta.3xcurses @@ -0,0 +1,98 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH meta 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +meta \- enable/disable meta keys +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBmeta\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is an ignored parameter. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.SH DESCRIPTION +.sp +.LP +Whether a terminal returns 7 or 8 significant bits initially depends on the +control mode of the terminal driver. The \fBmeta()\fR function forces the +number of bits to be returned by \fBgetch\fR(3XCURSES) to be 7 (if \fIbf\fR is +\fBFALSE\fR) or 8 (if \fIbf\fR is \fBTRUE\fR). +.sp +.LP +If the program handling the data can only pass 7-bit characters or strips the +8th bit, 8 bits cannot be handled. +.sp +.LP +If the \fBterminfo\fR capabilities \fBsmm\fR (meta_on) and \fBrmm\fR (meta_off) +are defined for the terminal, \fBsmm\fR is sent to the terminal when +\fBmeta(\fR\fIwin\fR\fB, TRUE)\fR is called, and \fBrmm\fR is sent when +\fBmeta(\fR\fIwin\fR\fB, FALSE)\fR is called. +.sp +.LP +This function is useful when extending the non-text command set in applications +where the META key is used. +.SH RETURN VALUES +.sp +.LP +On success, the \fBmeta()\fR function returns \fBOK\fR. Otherwise, it returns +\fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/move.3xcurses b/usr/src/man/man3xcurses/move.3xcurses new file mode 100644 index 0000000000..3b4b22ca05 --- /dev/null +++ b/usr/src/man/man3xcurses/move.3xcurses @@ -0,0 +1,101 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH move 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +move, wmove \- move cursor in window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBmove\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.LP +.nf +\fBint\fR \fBwmove\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the position of the cursor in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the position of the cursor in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the cursor is to be written. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBmove()\fR function moves the logical cursor (for \fBstdscr\fR) to the +position specified by \fIy\fR (row) and \fIx\fR (column), where the upper left +corner of the window is row 0, column 0. The \fBwmove()\fR function performs +the same action, but moves the cursor in the window specified by \fIwin\fR. +The physical cursor will not move until after a call to \fBrefresh\fR(3XCURSES) +or \fBdoupdate\fR(3XCURSES). +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/mvcur.3xcurses b/usr/src/man/man3xcurses/mvcur.3xcurses new file mode 100644 index 0000000000..a7fddda6f5 --- /dev/null +++ b/usr/src/man/man3xcurses/mvcur.3xcurses @@ -0,0 +1,112 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH mvcur 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +mvcur \- move the cursor +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBmvcur\fR(\fBint\fR \fIoldrow\fR, \fBint\fR \fIoldcol\fR, \fBint\fR \fInewrow\fR, \fBint\fR \fInewcol\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIoldrow\fR\fR +.ad +.RS 10n +.rt +Is the row from which cursor is to be moved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIoldcol\fR\fR +.ad +.RS 10n +.rt +Is the column from which cursor is to be moved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fInewrow\fR\fR +.ad +.RS 10n +.rt +Is the row to which cursor is to be moved. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fInewcol\fR\fR +.ad +.RS 10n +.rt +Is the column to which cursor is to be moved. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBmvcur()\fR function is a low-level function used only outside of X/Open +Curses when the program has to deal directly with the \fBterminfo\fR database +to handle certain terminal capabilities. The use of appropriate X/Open Curses +functions is recommended in all other situations, so that X/Open Curses can +track the cursor. +.sp +.LP +The \fBmvcur()\fR function moves the cursor from the location specified by +\fIoldrow\fR and \fIoldcol\fR to the location specified by \fInewrow\fR and +\fInewcol\fR. A program using this function must keep track of the current +cursor position. +.SH RETURN VALUES +.sp +.LP +On success, the \fBmvcur()\fR function returns \fBOK\fR. Otherwise, it returns +\fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/mvderwin.3xcurses b/usr/src/man/man3xcurses/mvderwin.3xcurses new file mode 100644 index 0000000000..ec9fac6dd6 --- /dev/null +++ b/usr/src/man/man3xcurses/mvderwin.3xcurses @@ -0,0 +1,101 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH mvderwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +mvderwin \- map area of parent window to subwindow +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBmvderwin\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIpar_y\fR, \fBint\fR \fIpar_x\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window to be mapped. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpar_y\fR\fR +.ad +.RS 9n +.rt +Is the y (row) coordinate of the placement of the upper left corner of window +relative to the parent window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpar_x\fR\fR +.ad +.RS 9n +.rt +Is the x (column) coordinate of the placement of the upper left corner of the +window relative to the parent window. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBmvderwin()\fR function defines a mapped area of \fIwin\fR's parent +window that is the same size as \fIwin\fR and has its upper left corner at +position \fIpar_y\fR, \fIpar_x\fR of the parent window. +.sp +.LP +Whenever \fIwin\fR is refreshed, its contents are updated to match those of the +mapped area and any reference to characters in \fIwin\fR is treated as a +reference to corresponding characters in the mapped area. +.SH RETURN VALUES +.sp +.LP +On success, the \fBmvderwin()\fR function returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdelwin\fR(3XCURSES), \fBderwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/mvprintw.3xcurses b/usr/src/man/man3xcurses/mvprintw.3xcurses new file mode 100644 index 0000000000..4dce21573c --- /dev/null +++ b/usr/src/man/man3xcurses/mvprintw.3xcurses @@ -0,0 +1,122 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH mvprintw 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +mvprintw, mvwprintw, printw, wprintw \- print formatted output window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBmvprintw\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwprintw\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.LP +.nf +\fBint\fR \fBprintw\fR(\fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.LP +.nf +\fBint\fR \fBwprintw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate position of the string's placement in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate position of the string's placement in the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIfmt\fR\fR +.ad +.RS 7n +.rt +Is a \fBprintf()\fR format string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the string is to be written. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBmvprintw()\fR, \fBmvwprintw()\fR, \fBprintw()\fR, and \fBwprintw()\fR +functions are analogous to \fBprintf\fR(3C). The effect of these functions is +as though \fBsprintf()\fR were used to format the string, and then +\fBwaddstr\fR(3XCURSES) were used to add that multi-byte string to the current +or specified window at the current or specified cursor position. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, these functions return \fBOK\fR. Otherwise, they +return \fBERR\fR. +.SH ERRORS +.sp +.LP + No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBprintf\fR(3C), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/mvscanw.3xcurses b/usr/src/man/man3xcurses/mvscanw.3xcurses new file mode 100644 index 0000000000..d70c80a67a --- /dev/null +++ b/usr/src/man/man3xcurses/mvscanw.3xcurses @@ -0,0 +1,121 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH mvscanw 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +mvscanw, mvwscanw, scanw, wscanw \- convert formatted input from a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBmvscanw\fR(\fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.LP +.nf +\fBint\fR \fBmvwscanw\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.LP +.nf +\fBint\fR \fBscanw\fR(\fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.LP +.nf +\fBint\fR \fBwscanw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fB\&.\|.\|.\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the position of the character to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the position of the character to be read. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIfmt\fR\fR +.ad +.RS 7n +.rt +Is a \fBscanf()\fR format string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which the character is to be read. +.RE + +.SH DESCRIPTION +.sp +.LP +These functions are similar to \fBscanf\fR(3C). Their effect is as though +\fBmvwgetstr\fR(3XCURSES) were called to get a multi-byte character string from +the current or specified window at the current or specified cursor position, +and then \fBsscanf()\fR were used to interpret and convert that string. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, these functions return \fBOK\fR. Otherwise, they +return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetnstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBprintw\fR(3XCURSES), +\fBscanf\fR(3C), \fBwcstombs\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/mvwin.3xcurses b/usr/src/man/man3xcurses/mvwin.3xcurses new file mode 100644 index 0000000000..79daa64df7 --- /dev/null +++ b/usr/src/man/man3xcurses/mvwin.3xcurses @@ -0,0 +1,96 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH mvwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +mvwin \- move window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBmvwin\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIy\fR, \fBint\fR \fIx\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window to move. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIy\fR\fR +.ad +.RS 7n +.rt +Is the y (row) coordinate of the upper left corner of the window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIx\fR\fR +.ad +.RS 7n +.rt +Is the x (column) coordinate of the upper left corner of the window. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBmvwin()\fR function moves the specified window (or subwindow), placing +its upper left corner at the positions specified by \fIx\fR and \fIy\fR. The +entire window must fit within the physical boundaries of the screen or an +error results. In the case of a subwindow, the window must remain within the +boundaries of the parent window. +.SH RETURN VALUES +.sp +.LP +On success, the \fBmvwin()\fR function returns \fBOK\fR. Otherwise, it returns +\fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBderwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/napms.3xcurses b/usr/src/man/man3xcurses/napms.3xcurses new file mode 100644 index 0000000000..639218ee05 --- /dev/null +++ b/usr/src/man/man3xcurses/napms.3xcurses @@ -0,0 +1,69 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH napms 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +napms \- sleep process for a specified length of time +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBnapms\fR(\fBint\fR \fIms\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIms\fR\fR +.ad +.RS 6n +.rt +Is the number of milliseconds to sleep. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBnapms()\fR function sleeps for at least \fIms\fR milliseconds. +.SH RETURN VALUES +.sp +.LP +The \fBnapms()\fR function always returns \fBOK\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdelay_output\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/newpad.3xcurses b/usr/src/man/man3xcurses/newpad.3xcurses new file mode 100644 index 0000000000..4d41ee65c5 --- /dev/null +++ b/usr/src/man/man3xcurses/newpad.3xcurses @@ -0,0 +1,233 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH newpad 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +newpad, pnoutrefresh, prefresh, subpad \- create or refresh a pad or subpad +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBWINDOW *\fR\fBnewpad\fR(\fBint\fR \fInlines\fR, \fBint\fR \fIncols\fR); +.fi + +.LP +.nf +\fBint\fR \fBpnoutrefresh\fR(\fBWINDOW *\fR\fIpad\fR, \fBint\fR \fIpminrow\fR, \fBint\fR \fIpmincol\fR, \fBint\fR \fIsminrow\fR, + \fBint\fR \fIsmincol\fR,\fBint\fR \fIsmaxrow\fR, \fBint\fR \fIsmaxcol\fR); +.fi + +.LP +.nf +\fBint\fR \fBprefresh\fR(\fBWINDOW *\fR\fIpad\fR, \fBint\fR \fIpminrow\fR, \fBint\fR \fIpmincol\fR, \fBint\fR \fIsminrow\fR, + \fBint\fR \fIsmincol\fR,\fBint\fR \fIsmaxrow\fR, \fBint\fR \fIsmaxcol\fR); +.fi + +.LP +.nf +\fBWINDOW *\fR\fBsubpad\fR(\fBWINDOW *\fR\fIorig\fR, \fBint\fR \fInlines\fR, \fBint\fR \fIncols\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fInlines\fR\fR +.ad +.RS 11n +.rt +Is the number of lines in the pad to be created. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIncols\fR\fR +.ad +.RS 11n +.rt +Is the number of columns in the pad to be created. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpad\fR\fR +.ad +.RS 11n +.rt +Is a pointer to the pad to refresh. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpminrow\fR\fR +.ad +.RS 11n +.rt +Is the row coordinate of the upper left corner of the pad rectangle to be +copied +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIpmincol\fR\fR +.ad +.RS 11n +.rt +Is the column coordinate of the upper left corner of the pad rectangle to be +copied. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIsminrow\fR\fR +.ad +.RS 11n +.rt +Is the row coordinate of the upper left corner of the rectangle on the physical +screen where pad is to be positioned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIsmincol\fR\fR +.ad +.RS 11n +.rt +Is the column coordinate of the upper left corner of the rectangle on the +physical screen where pad is to be positioned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIsmaxrow\fR\fR +.ad +.RS 11n +.rt +Is the row coordinate of the lower right corner of the rectangle on the +physical screen where the pad is to be positioned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIsmaxcol\fR\fR +.ad +.RS 11n +.rt +Is the column coordinate of the lower right corner of the rectangle on the +physical screen where the pad is to be positioned. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIorig\fR\fR +.ad +.RS 11n +.rt +Is a pointer to the parent pad within which a sub-pad is created. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBnewpad()\fR function creates a new pad with the specified number of +lines and columns. A pointer to the new pad structure is returned. A pad +differs from a window in that it is not restricted to the size of the physical +screen. It is useful when only part of a large window will be displayed at any +one time. +.sp +.LP +Automatic refreshes by scrolling or echoing of input do not take place when +pads are used. Pads have their own refresh commands, \fBprefresh()\fR and +\fBpnoutrefresh()\fR. +.sp +.LP +The \fBprefresh()\fR function copies the specified portion of the logical pad +to the terminal screen. The parameters \fIpmincol\fR and \fIpminrow\fR specify +the upper left corner of the rectangular area of the pad to be displayed. The +lower right coordinate of the rectangular area of the pad that is to be +displayed is calculated from the screen parameters (\fIsminrow\fR, +\fIsmincol\fR, \fIsmaxrow\fR, \fIsmaxcol\fR). +.sp +.LP +This function calls the \fBpnoutrefresh()\fR function to copy the specified +portion of \fIpad\fR to the terminal screen and the \fBdoupdate\fR(3XCURSES) +function to do the actual update. The logical cursor is copied to the same +location in the physical window unless \fBleaveok\fR(3XCURSES) is enabled (in +which case, the cursor is placed in a position that the program finds +convenient). +.sp +.LP +When outputting several pads at once, it is often more efficient to call the +\fBpnoutrefresh()\fR and \fBdoupdate()\fR functions directly. A call to +\fBpnoutrefresh()\fR for each pad first, followed by only one call to +\fBdoupdate()\fR to update the screen, results in one burst of output, fewer +characters sent, and less CPU time used. +.sp +.LP +The \fBsubpad()\fR function creates a sub-pad within the pad \fIorig\fR with +the specified number of lines and columns. A pointer to the new pad structure +is returned. The sub-pad is positioned in the middle of \fIorig\fR. Any +changes made to one pad affect the other. \fBtouchwin\fR(3XCURSES) or +\fBtouchline\fR(3XCURSES) will likely have to be called on pad \fIorig\fR to +correctly update the window. +.SH RETURN VALUES +.sp +.LP +On success, the \fBnewpad()\fR and \fBsubpad()\fR functions returns a pointer +to the new pad data structure. Otherwise, they return a null pointer. +.sp +.LP +On success, the \fBpnoutrefresh()\fR and \fBprefresh()\fR functions return +\fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBclearok\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), +\fBis_linetouched\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBpechochar\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/nl.3xcurses b/usr/src/man/man3xcurses/nl.3xcurses new file mode 100644 index 0000000000..c60e226eae --- /dev/null +++ b/usr/src/man/man3xcurses/nl.3xcurses @@ -0,0 +1,69 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH nl 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +nl, nonl \- enable/disable newline control +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBnl\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBnonl\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBnl()\fR function enables the handling of newlines. The \fBnl()\fR +function converts newline into carriage return and line feed on output and +converts carriage return into newline on input. \fBnonl()\fR disables the +handling of newlines. +.sp +.LP +The handling of newlines is initially enabled. Disabling the handling of +newlines results in faster cursor motion since X/Open Curses can use the +line-feed capability more efficiently. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/nodelay.3xcurses b/usr/src/man/man3xcurses/nodelay.3xcurses new file mode 100644 index 0000000000..e59837c860 --- /dev/null +++ b/usr/src/man/man3xcurses/nodelay.3xcurses @@ -0,0 +1,83 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH nodelay 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +nodelay \- set blocking or non-blocking read +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBnodelay\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which to enable non-blocking. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.SH DESCRIPTION +.sp +.LP +If enabled, (\fIbf\fR is \fBTRUE\fR), the \fBnodelay()\fR function causes +\fBgetch\fR(3XCURSES) to return \fBERR\fR if no input is ready. When disabled, +\fBgetch()\fR blocks until a key is pressed. +.SH RETURN VALUES +.sp +.LP +On success, the \fBnodelay()\fR function returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetch\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBnotimeout\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/noqiflush.3xcurses b/usr/src/man/man3xcurses/noqiflush.3xcurses new file mode 100644 index 0000000000..65c6958086 --- /dev/null +++ b/usr/src/man/man3xcurses/noqiflush.3xcurses @@ -0,0 +1,64 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH noqiflush 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +noqiflush, qiflush \- control flush of input and output on interrupt +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBvoid\fR \fBnoqiflush\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBqiflush\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBqiflush()\fR function enables the flushing of input and output queues +when an interrupt, quit, or suspend character is sent to the terminal. The +\fBnoqiflush()\fR function disables this flushing. +.SH RETURN VALUES +.sp +.LP +These functions do not return a value. +.SH ERRORS +.sp +.LP +None +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBflushinp\fR(3XCURSES), \fBintrflush\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/notimeout.3xcurses b/usr/src/man/man3xcurses/notimeout.3xcurses new file mode 100644 index 0000000000..8cf97749a4 --- /dev/null +++ b/usr/src/man/man3xcurses/notimeout.3xcurses @@ -0,0 +1,126 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH notimeout 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +notimeout, timeout, wtimeout \- set timed blocking or non-blocking read +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBnotimeout\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBtimeout\fR(\fBint\fR \fIdelay\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBwtimeout\fR(\fBWINDOW\fR \fIwin\fR, \fBint\fR \fIdelay\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to the window in which to set the timed blocking. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 9n +.rt +Is a Boolean expression. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIdelay\fR\fR +.ad +.RS 9n +.rt +Is the number of milliseconds to block or wait for input. +.RE + +.SH DESCRIPTION +.sp +.LP +If \fIbool\fR is \fBTRUE\fR, the \fBnotimeout()\fR function disables a timer +used by \fBgetch\fR(3XCURSES) when handling multibyte function key sequences. +.sp +.LP +When \fIbool\fR is \fBFALSE\fR and keypad handling is enabled, a timer is set +by \fBgetch()\fR to handle bytes received that could be the beginning of a +function key (for example, ESC). If the remainder of the sequence is not +received before the time expires, the first byte is returned; otherwise, the +value of the function key is returned. Subsequent calls to the \fBgetch()\fR +function will return the other bytes received for the incomplete key sequence. +.sp +.LP +The \fBtimeout()\fR and \fBwtimeout()\fR functions set the length of time +\fBgetch()\fR waits for input for windows \fBstdscr\fR and \fIwin\fR, +respectively. These functions are similar to \fBnodelay\fR(3XCURSES) except +the time to block or wait for input can be specified. +.sp +.LP +A negative \fIdelay\fR causes the program to wait indefinitely for input; a +\fIdelay\fR of \fB0\fR returns \fBERR\fR if no input is ready; and a positive +\fIdelay\fR blocks until input arrives or the time specified expires, (in which +case, \fBERR\fR is returned). +.SH RETURN VALUES +.sp +.LP +On success, the \fBnotimeout()\fR function returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.sp +.LP +The \fBtimeout()\fR and \fBwtimeout()\fR functions do not return a value. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBgetch\fR(3XCURSES), \fBhalfdelay\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBnodelay\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/overlay.3xcurses b/usr/src/man/man3xcurses/overlay.3xcurses new file mode 100644 index 0000000000..ba74889512 --- /dev/null +++ b/usr/src/man/man3xcurses/overlay.3xcurses @@ -0,0 +1,238 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH overlay 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +overlay, overwrite \- copy overlapped windows +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBoverlay\fR(\fBconst WINDOW *\fR\fIsrcwin\fR, \fBWINDOW *\fR\fIdstwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBoverwrite\fR(\fBconst WINDOW *\fR\fIsrcwin\fR, \fBWINDOW *\fR\fIdstwin\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIsrcwin\fR\fR +.ad +.RS 10n +.rt +Is a pointer to the source window to be copied. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIdstwin\fR\fR +.ad +.RS 10n +.rt +Is a pointer to the destination window to be overlayed or overwritten. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBoverwrite()\fR and \fBoverlay()\fR functions overlay \fIsrcwin\fR on top +of \fIdestwin\fR. The \fIsrcwin\fR and \fIdstwin\fR arguments do not have to be +the same size; only text where the two windows overlap is copied. +.sp +.LP +The \fBoverwrite()\fR function copies characters as though a sequence of +\fBwin_wch\fR(3XCURSES) and \fBwadd_wch\fR(3XCURSES) were performed with the +destination window's attributes and background attributes cleared. +.sp +.LP +The \fBoverlay()\fR function does the same thing, except that, whenever a +character to be copied is the background character of the source window, +\fBoverlay()\fR does not copy the character but merely moves the destination +cursor the width of the source background character. +.sp +.LP +If any portion of the overlaying window border is not the first column of a +multi-column character, then all the column positions will be replaced with the +background character and rendition before the overlay is done. If the default +background character is a multi-column character when this occurs, then these +functions fail. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, these functions return \fBOK\fR. Otherwise, they +return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH EXAMPLES +.LP +\fBExample 1 \fRImplement a pop-up dialog +.sp +.LP +The following example demonstrates the use of \fBoverwrite()\fR to implement a +pop-up dialog box. + +.sp +.in +2 +.nf +#include <curses.h> +/* + * Pop-up a window on top of curscr. If row and/or col + * are -1 then that dimension will be centered within + * curscr. Return 0 for success or -1 if malloc(\|) failed. + * Pass back the working window and the saved window for the + * pop-up. The saved window should not be modified. + */ +int +popup(work, save, nrows, ncols, row, col) +WINDOW **work, **save; +int nrows, ncols, row, col; +{ + int mr, mc; + getmaxyx(curscr, mr, mc); + /* Windows are limited to the size of curscr. */ + if (mr < nrows) + nrows = mr; + if (mc < ncols) + ncols = mc; + /* Center dimensions. */ + if (row == -1) + row = (mr-nrows)/2; + if (col == -1) + col = (mc-ncols)/2; + /* The window must fit entirely in curscr. */ + if (mr < row+nrows) + row = 0; + if (mc < col+ncols) + col = 0; + *work = newwin(nrows, ncols, row, col); + if (*work == NULL) + return (-1); + if ((*save = dupwin(*work)) == NULL) { + delwin(*work); + return (-1); + } + overwrite(curscr, *save); + return (0); +} +/* + * Restore the region covered by a pop-up window. + * Delete the working window and the saved window. + * This function is the complement to popup(\|). Return + * 0 for success or -1 for an error. + */ +int +popdown(work, save) +WINDOW *work, *save; +{ + (void) wnoutrefresh(save); + (void) delwin(save); + (void) delwin(work); + return (0); +} +/* + * Compute the size of a dialog box that would fit around + * the string. + */ +void +dialsize(str, nrows, ncols) +char *str; +int *nrows, *ncols; +{ + int rows, cols, col; + for (rows = 1, cols = col = 0; *str != '\e0'; ++str) { + if (*str == '\en') { + if (cols < col) + cols = col; + col = 0; + ++rows; + } else { + ++col; + } + } + if (cols < col) + cols = col; + *nrows = rows; + *ncols = cols; +} +/* + * Write a string into a dialog box. + */ +void +dialfill(w, s) +WINDOW *w; +char *s; +{ + int row; + (void) wmove(w, 1, 1); + for (row = 1; *s != '\e0'; ++s) { + (void) waddch(w, *((unsigned char*) s)); + if (*s == '\en') + wmove(w, ++row, 1); + } + box(w, 0, 0); +} +void +dialog(str) +char *str; +{ + WINDOW *work, *save; + int nrows, ncols, row, col; + /* Figure out size of window. */ + dialsize(str, &nrows, &ncols); + /* Create a centered working window with extra */ + /* room for a border. */ + (void) popup(&work, &save, nrows+2, ncols+2, -1, -1); + /* Write text into the working window. */ + dialfill(work, str); + /* Pause. Remember that wgetch(\|) will do a wrefresh(\|) */ + /* for us. */ + (void) wgetch(work); + /* Restore curscr and free windows. */ + (void) popdown(work, save); + /* Redraw curscr to remove window from physical screen. */ + (void) doupdate(\|); +} +.fi +.in -2 + +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBcopywin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBwadd_wch\fR(3XCURSES), +\fBwin_wch\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/pechochar.3xcurses b/usr/src/man/man3xcurses/pechochar.3xcurses new file mode 100644 index 0000000000..b198c8f371 --- /dev/null +++ b/usr/src/man/man3xcurses/pechochar.3xcurses @@ -0,0 +1,100 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH pechochar 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +pechochar, pecho_wchar \- add character and refresh window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBpechochar\fR(\fBWINDOW *\fR\fIpad\fR, \fBchtype\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBpecho_wchar\fR(\fBWINDOW *\fR\fIpad\fR, \fBconst chtype *\fR\fIwch\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIpad\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the pad in which the character is to be added. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the character to be written to the pad. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the complex character to be written to the pad. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBpechochar()\fR function is equivalent to calling \fBwaddch\fR(3XCURSES) +followed by a call to \fBprefresh\fR(3XCURSES). The \fBpecho_wchar()\fR +function is equivalent to calling \fBwadd_wch\fR(3XCURSES) followed by a call +to \fBprefresh()\fR. \fBprefresh()\fR reuses the last position of the pad on +the screen for its parameters. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBadd_wch\fR(3XCURSES), \fBaddch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBnewpad\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/putp.3xcurses b/usr/src/man/man3xcurses/putp.3xcurses new file mode 100644 index 0000000000..857865027a --- /dev/null +++ b/usr/src/man/man3xcurses/putp.3xcurses @@ -0,0 +1,121 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH putp 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +putp, tputs \- apply padding information and output string +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBputp\fR(\fBconst char *\fR\fIstr\fR); +.fi + +.LP +.nf +\fBint\fR \fBtputs\fR(\fBconst char *\fR\fIstr\fR, \fBint\fR \fIaffcnt\fR, \fBint (*\fR\fIputfunc\fR) (int)); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIstr\fR\fR +.ad +.RS 11n +.rt +Is a pointer to a \fBterminfo\fR variable or return value from +\fBtgetstr\fR(3XCURSES), \fBtgoto\fR(3XCURSES), \fBtigetstr\fR(3XCURSES), or +\fBtparm\fR(3XCURSES). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIaffcnt\fR\fR +.ad +.RS 11n +.rt +Is the number of lines affected, or 1 if not relevant. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIputfunc\fR\fR +.ad +.RS 11n +.rt +Is the output function. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBputp()\fR and \fBtputs()\fR functions are low-level functions used to +deal directly with the \fBterminfo\fR database. The use of appropriate X/Open +Curses functions is recommended for most situations. +.sp +.LP +The \fBtputs()\fR function adds padding information and then outputs \fIstr\fR. +\fIstr\fR must be a \fBterminfo\fR string variable or the result value from +\fBtgetstr()\fR, \fBtgoto()\fR, \fBtigetstr()\fR, or \fBtparm()\fR. The +\fBtputs()\fR function replaces the padding specification (if one exists) with +enough characters to produce the specified delay. Characters are output one at +a time to \fIputfunc\fR, a user-specified function similar to +\fBputchar\fR(3C). +.sp +.LP +The \fBputp()\fR function calls \fBtputs()\fR as follows: +.sp +.LP +\fBtputs(\fR\fIstr\fR, 1, putchar) +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. +.SH ERRORS +.sp +.LP +None. +.SH USAGE +.sp +.LP +The output of \fBputp()\fR goes to \fBstdout\fR, not to the file descriptor, +\fIfildes\fR, specified in \fBsetupterm\fR(3XCURSES). +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBputchar\fR(3C), \fBsetupterm\fR(3XCURSES), +\fBtgetent\fR(3XCURSES), \fBtigetflag\fR(3XCURSES), \fBterminfo\fR(4), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/redrawwin.3xcurses b/usr/src/man/man3xcurses/redrawwin.3xcurses new file mode 100644 index 0000000000..03a8c1d17c --- /dev/null +++ b/usr/src/man/man3xcurses/redrawwin.3xcurses @@ -0,0 +1,111 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH redrawwin 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +redrawwin, wredrawln \- redraw screen or portion of screen +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBredrawwin\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBwredrawln\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIbeg_line\fR, \fBint\fR \fInum_lines\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 13n +.rt +Is a pointer to the window in which to redraw. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbeg_line\fR\fR +.ad +.RS 13n +.rt +Is the first line to redraw. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fInum_lines\fR\fR +.ad +.RS 13n +.rt +Is the number of lines to redraw. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBredrawwin()\fR and \fBwredrawln()\fR functions force portions of a +window to be redrawn to the terminal when the next refresh operation is +performed. +.sp +.LP +The \fBredrawwin()\fR function forces the entire window \fIwin\fR to be +redrawn, while the \fBwredrawln()\fR function forces only \fInum_lines\fR lines +starting with \fIbeg_line\fR to be redrawn. Normally, refresh operations use +optimization methods to reduce the actual amount of the screen to redraw based +on the current screen contents. These functions tell the refresh operations +not to attempt any optimization when redrawing the indicated areas. +.sp +.LP +These functions are useful when the data that exists on the screen is believed +to be corrupt and for applications such as screen editors that redraw portions +of the screen. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/resetty.3xcurses b/usr/src/man/man3xcurses/resetty.3xcurses new file mode 100644 index 0000000000..ead124fbd7 --- /dev/null +++ b/usr/src/man/man3xcurses/resetty.3xcurses @@ -0,0 +1,64 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH resetty 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +resetty, savetty \- restore/save terminal modes +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBresetty\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBsavetty\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBsavetty()\fR and \fBresetty()\fR functions save and restore the +terminal state, respectively. The \fBsavetty()\fR function saves the current +state in a buffer; the \fBresetty()\fR function restores the state to that +stored in the buffer at the time of the last \fBsavetty()\fR call. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/ripoffline.3xcurses b/usr/src/man/man3xcurses/ripoffline.3xcurses new file mode 100644 index 0000000000..a898d3c5b3 --- /dev/null +++ b/usr/src/man/man3xcurses/ripoffline.3xcurses @@ -0,0 +1,112 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ripoffline 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +ripoffline \- reserve screen line for dedicated purpose +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBripoffline\fR(\fBint\fR \fIline\fR, \fBint (*init)(WINDOW *\fR\fIwin\fR, \fBint\fR \fIwidth\fR)); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIline\fR\fR +.ad +.RS 9n +.rt +determines whether the screen line being reserved comes from the top of +\fBstdscr\fR (\fBline\fR is positive) or the bottom (\fBline\fR is negative). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIinit\fR\fR +.ad +.RS 9n +.rt +Is a pointer to a function that initializes the one-line window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 9n +.rt +Is a pointer to one-line window created by this function. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwidth\fR\fR +.ad +.RS 9n +.rt +Is the number of columns in the window pointed to by the \fIwin\fR parameter. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBripoffline()\fR function reserves a screen line as a one line window. +.sp +.LP +To use this function, it must be called before you call \fBinitscr\fR(3XCURSES) +or \fBnewterm\fR(3XCURSES). When \fBinitscr()\fR or \fBnewterm()\fR is called, +so is the function pointed to by \fBinit\fR. The function pointed to by +\fBinit\fR takes two arguments: a pointer to the one-line window and the number +of columns in that window. This function cannot use the \fBLINES\fR or +\fBCOLS\fR variables and cannot call \fBwrefresh\fR(3XCURSES) or +\fBdoupdate\fR(3XCURSES), but may call \fBwnoutrefresh\fR(3XCURSES). +.SH RETURN VALUES +.sp +.LP +The \fBrioffline()\fR function always returns \fBOK\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBinitscr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBslk_attroff\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/scr_dump.3xcurses b/usr/src/man/man3xcurses/scr_dump.3xcurses new file mode 100644 index 0000000000..b4d0bd7353 --- /dev/null +++ b/usr/src/man/man3xcurses/scr_dump.3xcurses @@ -0,0 +1,109 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH scr_dump 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +scr_dump, scr_init, scr_restore, scr_set \- write screen contents to/from a +file +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBscr_dump\fR(\fBconst char *\fR\fIfilename\fR); +.fi + +.LP +.nf +\fBint\fR \fBscr_init\fR(\fBconst char *\fR\fIfilename\fR); +.fi + +.LP +.nf +\fBint\fR \fBscr_restore\fR(\fBconst char *\fR\fIfilename\fR); +.fi + +.LP +.nf +\fBint\fR \fBscr_set\fR(\fBconst char *\fR\fIfilename\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIfilename\fR\fR +.ad +.RS 12n +.rt +Is a pointer to the file in which screen contents are written. +.RE + +.SH DESCRIPTION +.sp +.LP +These function perform input/output functions on a screen basis. +.sp +.LP +The \fBscr_dump()\fR function writes the contents of the virtual screen, +\fBcurscr\fR, to \fIfilename\fR. +.sp +.LP +The \fBscr_restore()\fR function reads the contents of \fIfilename\fR from +\fBcurscr\fR (which must have been written with \fBscr_dump()\fR). The next +refresh operation restores the screen to the way it looks in \fIfilename\fR. +.sp +.LP +The \fBscr_init()\fR function reads the contents of \fIfilename\fR and uses +those contents to initialize the X/Open Curses data structures to what is +actually on screen. The next refresh operation bases its updates on this data, +unless the terminal has been written to since \fIfilename\fR was saved or the +\fBterminfo\fR capabilities \fBrmcup\fR and \fBnrrmc\fR are defined for the +current terminal. +.sp +.LP +The \fBscr_set()\fR function combines \fBscr_restore()\fR and +\fBscr_init()\fR. It informs the program that the contents of the file +\fIfilename\fR are what is currently on the screen and that the program wants +those contents on the screen. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdelscreen\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), \fBendwin\fR(3XCURSES), +\fBgetwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/scrl.3xcurses b/usr/src/man/man3xcurses/scrl.3xcurses new file mode 100644 index 0000000000..32a7bf3aff --- /dev/null +++ b/usr/src/man/man3xcurses/scrl.3xcurses @@ -0,0 +1,100 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH scrl 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +scrl, scroll, wscrl \- scroll a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBscrl\fR(\fBint\fR \fIn\fR); +.fi + +.LP +.nf +\fBint\fR \fBscroll\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBwscrl\fR(\fBWINDOW *\fR\fIwin\fR, \fBint\fR \fIn\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIn\fR\fR +.ad +.RS 7n +.rt +number and direction of lines to scroll +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +pointer to the window in which to scroll +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBscroll()\fR function scrolls the window \fIwin\fR up one line. The +current cursor position is not changed. +.sp +.LP +The \fBscrl()\fR and \fBwscrl()\fR functions scroll the window \fBstdscr\fR or +\fIwin\fR up or down \fIn\fR lines, where \fIn\fR is a positive (scroll up) or +negative (scroll down) integer. +.sp +.LP +The \fBscrollok\fR(3XCURSES) function must be enabled for these functions to +work. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBclearok\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/set_term.3xcurses b/usr/src/man/man3xcurses/set_term.3xcurses new file mode 100644 index 0000000000..07c6d04982 --- /dev/null +++ b/usr/src/man/man3xcurses/set_term.3xcurses @@ -0,0 +1,71 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH set_term 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +set_term \- switch between terminals +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBSCREEN *\fR\fBset_term\fR(\fBSCREEN *\fR\fInew\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fInew\fR\fR +.ad +.RS 7n +.rt +Is the new terminal to which the \fBset_term()\fR function will switch. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBset_term()\fR function switches to the terminal specified by \fInew\fR +and returns a screen reference to the previous terminal. Calls to subsequent +X/Open Curses functions affect the new terminal. +.SH RETURN VALUES +.sp +.LP +On success, the \fBset_term()\fR function returns a pointer to the previous +screen. Otherwise, it returns a null pointer. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/setcchar.3xcurses b/usr/src/man/man3xcurses/setcchar.3xcurses new file mode 100644 index 0000000000..2672fa951e --- /dev/null +++ b/usr/src/man/man3xcurses/setcchar.3xcurses @@ -0,0 +1,120 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH setcchar 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +setcchar \- set a cchar_t type character from a wide character and rendition +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBsetcchar\fR(\fBcchar_t *\fR\fIwcval\fR, \fBconst wchar_t *\fR\fIwch\fR, \fBconst attr_t\fR \fIattrs\fR, + \fBshort\fR \fIcolor_pair\fR, \fBconst void *\fR\fIopts\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwcval\fR\fR +.ad +.RS 14n +.rt +Is a pointer to a location where a \fBcchar_t\fR character (and its rendition) +can be stored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 14n +.rt +Is a pointer to a wide character. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIattrs\fR\fR +.ad +.RS 14n +.rt +Is the set of attributes to apply to \fIwch\fR in creating \fIwcval\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcolor_pair\fR\fR +.ad +.RS 14n +.rt +Is the color pair to apply to \fIwch\fR in creating \fIwcval\fR. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIopts\fR\fR +.ad +.RS 14n +.rt +Is reserved for future use. Currently, this must be a null pointer. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBsetcchar()\fR function takes the wide character pointed to by \fIwch\fR, +combines it with the attributes indicated by \fIattrs\fR and the color pair +indicated by \fIcolor_pair\fR and stores the result in the object pointed to by +\fIwcval\fR. +.SH RETURN VALUES +.sp +.LP +On success, the \fBsetcchar()\fR function returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattroff\fR(3XCURSES), \fBcan_change_color\fR(3XCURSES), +\fBgetcchar\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/slk_attroff.3xcurses b/usr/src/man/man3xcurses/slk_attroff.3xcurses new file mode 100644 index 0000000000..2be6899595 --- /dev/null +++ b/usr/src/man/man3xcurses/slk_attroff.3xcurses @@ -0,0 +1,331 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH slk_attroff 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +slk_attroff, slk_attr_off, slk_attron, slk_attr_on, slk_attrset, slk_attr_set, +slk_clear, slk_color, slk_init, slk_label, slk_noutrefresh, slk_refresh, +slk_restore, slk_set, slk_touch, slk_wset \- soft label functions +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBslk_attroff\fR(\fBconst chtype\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_attr_off\fR(\fBconst attr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_attron\fR(\fBconst chtype\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_attr_on\fR(\fBconst attr_t\fR \fIattrs\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_attrset\fR(\fBconst chtype\fR \fIattrs\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_attr_set\fR(\fBconst attr_t\fR \fIattrs\fR, \fBshort\fR \fIcolor_pair_number\fR, \fBvoid *\fR\fIopts\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_clear\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_color\fR(\fBshort\fR \fIcolor_pair_number\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_init\fR(\fBint\fR \fIfmt\fR); +.fi + +.LP +.nf +\fBchar *\fR\fBslk_label\fR(\fBint\fR \fIlabnum\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_noutrefresh\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_refresh\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_restore\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_set\fR(\fBint\fR \fIlabnum\fR, \fBconst char *\fR\fIlabel\fR, \fBint\fR \fIjustify\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_touch\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBslk_wset\fR(\fBint\fR \fIlabnum\fR, \fBconst wchar_t *\fR\fIlabel\fR, \fBint\fR \fIjustify\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIattrs\fR\fR +.ad +.RS 21n +.rt +are the window attributes to be added or removed. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIopts\fR\fR +.ad +.RS 21n +.rt +Is reserved for future use. Currently, this must be a null pointer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcolor_pair_number\fR\fR +.ad +.RS 21n +.rt +Is a color pair. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIfmt\fR\fR +.ad +.RS 21n +.rt +Is the format of how the labels are arranged on the screen. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIlabnum\fR\fR +.ad +.RS 21n +.rt +Is the number of the soft label. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIlabel\fR\fR +.ad +.RS 21n +.rt +Is the name to be given to a soft label. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIjustify\fR\fR +.ad +.RS 21n +.rt +Is a number indicating how to justify the label name. +.RE + +.SH DESCRIPTION +.sp +.LP +The Curses interface manipulates the set of soft function-key labels that exist +on many terminals. For those terminals that do not have soft labels, Curses +takes over the bottom line of \fIstdscr\fR, reducing the size of \fIstdscr\fR +and the value of the \fBLINES\fR external variable. There can be up to eight +labels of up to eight display columns each. +.sp +.LP +To use soft labels, \fBslk_init()\fR must be called before calling +\fBinitscr\fR(3XCURSES), \fBnewterm\fR(3XCURSES), or +\fBripoffline\fR(3XCURSES). If \fBinitscr()\fR eventually uses a line from +\fIstdscr\fR to emulate the soft labels, then \fIfmt\fR determines how the +labels are arranged on the screen. Setting \fIfmt\fR to 0 indicates a 3-2-3 +arrangement of the labels; 1 indicates a 4-4 arrangement. Other values for +\fIfmt\fR are unspecified. +.sp +.LP +The \fBslk_init()\fR function has the effect of calling \fBripoffline()\fR to +reserve one screen line to accommodate the requested format. +.sp +.LP +The \fBslk_set()\fR and \fBslk_wset()\fR functions specify the text of soft +label number \fIlabnum\fR, within the range from 1 to and including 8. The +\fIlabel\fR argument is the string to be put the lable. With \fBslk_set()\fR +and \fBslk_wset()\fR, the width of the label is limited to eight columns +positions. A null string or a null pointer specifies a blank label. The +\fIjustify\fR argument can have the following values to indicate how to justify +\fIlabel\fR within the space reserved for it: +.sp +.ne 2 +.mk +.na +\fB0\fR +.ad +.RS 5n +.rt +Align the start of \fIlabel\fR with the start of the space +.RE + +.sp +.ne 2 +.mk +.na +\fB1\fR +.ad +.RS 5n +.rt +Center \fIlabel\fR within the space +.RE + +.sp +.ne 2 +.mk +.na +\fB2\fR +.ad +.RS 5n +.rt +Align the end of \fIlabel\fR with the end of the space +.RE + +.sp +.LP +The \fBslk_refresh()\fR and \fBslk_noutrefresh()\fR functions correspond to the +\fBwrefresh\fR(3XCURSES) and \fBwnoutrefresh\fR(3XCURSES) functions. +.sp +.LP +The \fBslk_label()\fR function obtains soft label number \fIlabnum\fR. +.sp +.LP +The \fBslk_clear()\fR function immediately clears the soft labels from the +screen. +.sp +.LP +The \fBslk_restore()\fR function immediately restores the soft labels to the +screen after a call to \fBslk_clear()\fR. +.sp +.LP +The \fBslk_touch()\fR function forces all the soft labels to be output the next +time \fBslk_refresh()\fR or \fBslk_noutrefresh()\fR is called. +.sp +.LP +The \fBslk_attron()\fR, \fBslk_attrset()\fR, and \fBslk_attroff()\fR functions +correspond to the \fBattron\fR(3XCURSES), \fBattrset\fR(3XCURSES), and +\fBattroff\fR(3XCURSES) functions. They have an effect only if soft labels are +stimulated on the bottom line of the screen. +.sp +.LP +The \fBslk_attr_on()\fR, \fBslk_attr_off()\fR, \fBslk_attr_set()\fR and +\fBslk_color()\fR functions correspond to the \fBattr_on\fR(3XCURSES), +\fBattr_off\fR(3XCURSES), \fBattr_set\fR(3XCURSES), and +\fBcolor_set\fR(3XCURSES) functions. As a result, they support color and the +attribute constants with the \fBWA_\fR prefix. +.sp +.LP +The \fIopts\fR argument is reserved for definition in a future release. +Currently, the \fIopts\fR argument is a null pointer. +.SH RETURN VALUES +.sp +.LP + Upon successful completion, the \fBslk_label()\fR function returns the +requested label with leading and trailing blanks stripped. Otherwise, it +returns a null pointer. +.sp +.LP + Upon successful completion, the other functions return \fBOK\fR. Otherwise, +they return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP + When using multi-byte character sets, applications should check the width of +the string by calling \fBmbstowcs\fR(3C) and then \fBwcswidth\fR(3C) before +calling \fBslk_set()\fR. When using wide characters, applications should check +the width of the string by calling \fBwcswidth()\fR before calling +\fBslk_set()\fR. +.sp +.LP +Since the number of columns that a wide string will occupy is codeset-specific, +call \fBwcwidth\fR(3C) and \fBwcswidth\fR(3C) to check the number of column +positions in the string before calling \fBslk_wset()\fR. +.sp +.LP + Most applications would use \fBslk_noutrefresh()\fR because a \fBwrefresh()\fR +is likely to follow soon. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattr_get\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBdelscreen\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBmbstowcs\fR(3C), \fBripoffline\fR(3XCURSES), +\fBwcswidth\fR(3C), \fBwcwidth\fR(3C), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/standend.3xcurses b/usr/src/man/man3xcurses/standend.3xcurses new file mode 100644 index 0000000000..c16889d70c --- /dev/null +++ b/usr/src/man/man3xcurses/standend.3xcurses @@ -0,0 +1,89 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH standend 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +standend, standout, wstandend, wstandout \- set/clear window attributes +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBstandend\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBstandout\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBint\fR \fBwstandend\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBint\fR \fBwstandout\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to the window in which attribute changes are to be made. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBstandend()\fR and \fBwstandend()\fR functions turn off all attributes +associated with \fBstdscr\fR and \fIwin\fR respectively. +.sp +.LP +The \fBstandout()\fR and \fBwstandout()\fR functions turn on the +\fBA_STANDOUT\fR attribute of \fBstdscr\fR and \fIwin\fR respectively. +.SH RETURN VALUES +.sp +.LP +These functions always return 1. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattr_get\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/stdscr.3xcurses b/usr/src/man/man3xcurses/stdscr.3xcurses new file mode 100644 index 0000000000..3c5d1c6379 --- /dev/null +++ b/usr/src/man/man3xcurses/stdscr.3xcurses @@ -0,0 +1,51 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH stdscr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +stdscr \- default window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR \fB/usr/xpg4/include\fR \fB-L\fR \fB/usr/xpg4/lib\fR \e +\fB-R\fR \fB/usr/xpg4/lib\fR \fB-lcurses\fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +extern WINDOW *stdscr; +.fi + +.SH DESCRIPTION +.sp +.LP +The external variable \fBstdscr\fR specifies the default window used by +functions that to not specify a window using an argument of type \fBWINDOW +*\fR. Other windows may be created using \fBnewwin()\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBderwin\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/syncok.3xcurses b/usr/src/man/man3xcurses/syncok.3xcurses new file mode 100644 index 0000000000..becbc35187 --- /dev/null +++ b/usr/src/man/man3xcurses/syncok.3xcurses @@ -0,0 +1,116 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH syncok 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +syncok, wcursyncup, wsyncdown, wsyncup \- synchronize window with its parents +or children +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBsyncok\fR(\fBWINDOW *\fR\fIwin\fR, \fBbool\fR \fIbf\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBwcursyncup\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBwsyncdown\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.LP +.nf +\fBvoid\fR \fBwsyncup\fR(\fBWINDOW *\fR\fIwin\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 7n +.rt +Is a pointer to a window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIbf\fR\fR +.ad +.RS 7n +.rt +Is a Boolean expression. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBsyncok()\fR function uses the value of \fIbf\fR to determine whether or +not the window \fIwin\fR's ancestors are implicitly touched whenever there is a +change to \fIwin\fR. If \fIbf\fR is \fBTRUE\fR, this touching occurs. If +\fIbf\fR is \fBFALSE\fR, it does not occur. The initial value for \fIbf\fR is +\fBFALSE\fR. +.sp +.LP +The \fBwcursyncup()\fR function moves the cursor in \fIwin\fR's ancestors to +match its position in \fIwin\fR. +.sp +.LP +The \fBwsyncdown()\fR function touches \fIwin\fR if any of its ancestors have +been touched. +.sp +.LP +The \fBwsyncup()\fR function touches all ancestors of \fIwin\fR. +.SH RETURN VALUES +.sp +.LP +On success, the \fBsyncok()\fR function returns \fBOK\fR. Otherwise, it returns +\fBERR\fR. +.sp +.LP +The other functions do not return a value. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBderwin\fR(3XCURSES), \fBdoupdate\fR(3XCURSES), +\fBis_linetouched\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/termattrs.3xcurses b/usr/src/man/man3xcurses/termattrs.3xcurses new file mode 100644 index 0000000000..fb38ee624d --- /dev/null +++ b/usr/src/man/man3xcurses/termattrs.3xcurses @@ -0,0 +1,72 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH termattrs 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +termattrs, term_attrs \- get supported terminal video attributes +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBchtype\fR \fBtermattrs\fR(\fBvoid\fR); +.fi + +.LP +.nf +\fBattr_t\fR \fBterm_attrs\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBtermattrs()\fR function extracts the video attributes of the current +terminal which is supported by the \fBchtype\fR data type. +.sp +.LP +The \fBterm_attrs()\fR function extracts information for the video attributes +of the current terminal which is supported for a \fBcchar_t\fR. +.SH RETURN VALUES +.sp +.LP +The \fBtermattrs()\fR function returns a logical \fBOR\fR of \fBA_\fR values of +all video attributes supported by the terminal. +.sp +.LP +The \fBterm_attrs()\fR function returns a logical \fBOR\fR of \fBWA_\fR values +of all video attributes supported by the terminal. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBattr_get\fR(3XCURSES), \fBattroff\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/termname.3xcurses b/usr/src/man/man3xcurses/termname.3xcurses new file mode 100644 index 0000000000..4852072e49 --- /dev/null +++ b/usr/src/man/man3xcurses/termname.3xcurses @@ -0,0 +1,58 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH termname 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +termname \- return the value of the environmental variable TERM +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBchar *\fR\fBtermname\fR(\fBvoid\fR); +.fi + +.SH DESCRIPTION +.sp +.LP +The \fBtermname()\fR function returns a pointer to the value of the +environmental variable \fBTERM\fR (truncated to 14 characters). +.SH RETURN VALUES +.sp +.LP +The \fBtermname()\fR returns a pointer to the terminal's name. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdel_curterm\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), +\fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/tgetent.3xcurses b/usr/src/man/man3xcurses/tgetent.3xcurses new file mode 100644 index 0000000000..12eecf668c --- /dev/null +++ b/usr/src/man/man3xcurses/tgetent.3xcurses @@ -0,0 +1,191 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH tgetent 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +tgetent, tgetflag, tgetnum, tgetstr, tgoto \- emulate the termcap database +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <term.h> + +\fBint\fR \fBtgetent\fR(\fBchar *\fR\fIbp\fR, \fBconst char *\fR\fIname\fR); +.fi + +.LP +.nf +\fBint\fR \fBtgetflag\fR(\fBchar\fR \fIid\fR[2]); +.fi + +.LP +.nf +\fBint\fR \fBtgetnum\fR(\fBchar\fR \fIid\fR[2]); +.fi + +.LP +.nf +\fBchar *\fR\fBtgetstr\fR(\fBchar\fR \fIid\fR[2], \fBchar **\fR\fIarea\fR); +.fi + +.LP +.nf +\fBchar *\fR\fBtgoto\fR(\fBchar *\fR\fIcap\fR, \fBint\fR \fIcol\fR, \fBint\fR \fIrow\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIbp\fR\fR +.ad +.RS 8n +.rt +Is a pointer to a buffer. This parameter is ignored. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIname\fR\fR +.ad +.RS 8n +.rt +Is the \fBtermcap\fR entry to look up. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcap\fR\fR +.ad +.RS 8n +.rt +Is the pointer to a \fBtermcap\fR capability. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIarea\fR\fR +.ad +.RS 8n +.rt +Is a pointer to the area where \fBtgetstr()\fR stores the decoded string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcol\fR\fR +.ad +.RS 8n +.rt +Is the column placement of the new cursor. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIrow\fR\fR +.ad +.RS 8n +.rt +Is the row placement of the new cursor. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBtgetent()\fR function looks up the \fBtermcap\fR entry for \fIname\fR. +The emulation ignores the buffer pointer \fIbp\fR. +.sp +.LP +The \fBtgetflag()\fR function gets the Boolean entry for \fIid\fR. +.sp +.LP +The \fBtgetnum()\fR function gets the numeric entry for \fIid\fR. +.sp +.LP +The \fBtgetstr()\fR function gets the string entry for \fIid\fR. If \fIarea\fR +is not a null pointer and does not point to a null pointer, \fBtgetstr()\fR +copies the string entry into the buffer pointed to by *\fIarea\fR and advances +the variable pointed to by \fIarea\fR to the first byte after the copy of the +string entry. +.sp +.LP +The \fBtgoto()\fR function instantiates the parameters \fIcol\fR and \fIrow\fR +into the capability \fIcap\fR and returns a pointer to the resulting string. +.sp +.LP +All of the information available in the \fBterminfo\fR database need not be +available through these functions. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, those functions that return integers return +\fBOK\fR. Otherwise, they return \fBERR\fR. +.sp +.LP +Those functions that return pointers return a null pointer when an error +occurs. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +These functions are included as a conversion aid for programs that use the +\fBtermcap\fR library. Their arguments are the same and the functions are +emulated using the \fBterminfo\fR database. +.sp +.LP +These functions are only guaranteed to operate reliably on character sets in +which each character fits into a single byte, whose attributes can be expressed +using only constants with the \fBA_\fR prefix. +.sp +.LP +Any terminal capabilities from the \fBterminfo\fR database that cannot be +retrieved using these functions can be retrieved using the functions described +on the \fBtigetflag\fR(3XCURSES) manual page. +.sp +.LP +Portable applications must use \fBtputs\fR(3XCURSES) to output the strings +returned by \fBtgetstr()\fR and \fBtgoto()\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBputp\fR(3XCURSES), \fBsetupterm\fR(3XCURSES), +\fBtigetflag\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/tigetflag.3xcurses b/usr/src/man/man3xcurses/tigetflag.3xcurses new file mode 100644 index 0000000000..dd9c54b17b --- /dev/null +++ b/usr/src/man/man3xcurses/tigetflag.3xcurses @@ -0,0 +1,141 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH tigetflag 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +tigetflag, tigetnum, tigetstr, tparm \- return the value of a terminfo +capability +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <term.h> + +\fBint\fR \fBtigetflag\fR(\fBchar *\fR\fIcapname\fR); +.fi + +.LP +.nf +\fBint\fR \fBtigetnum\fR(\fBchar *\fR\fIcapname\fR); +.fi + +.LP +.nf +\fBchar *\fR\fBtigetstr\fR(\fBchar *\fR\fIcapname\fR); +.fi + +.LP +.nf +\fBchar *\fR\fBtparm\fR(\fBchar *\fR\fIcap\fR, \fBlong\fR \fIp1\fR, \fBlong\fR \fIp2\fR, \fBlong\fR \fIp3\fR, \fBlong\fR \fIp4\fR, \fBlong\fR \fIp5\fR, + \fBlong\fR \fIp6\fR, \fBlong\fR \fIp7\fR,\fBlong\fR \fIp8\fR, \fBlong\fR \fIp9\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIcapname\fR\fR +.ad +.RS 11n +.rt +Is the name of the \fBterminfo\fR capability for which the value is required. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcap\fR\fR +.ad +.RS 11n +.rt +Is a pointer to a string capability. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIp1\fR...\fIp9\fR\fR +.ad +.RS 11n +.rt +Are the parameters to be instantiated. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBtigetflag()\fR, \fBtigetnum()\fR, and \fBtigetstr()\fR functions return +values for \fBterminfo\fR capabilities passed to them. +.sp +.LP +The following null-terminated arrays contain the \fIcapnames\fR, the +\fBtermcap\fR codes and full C names for each of the \fBterminfo\fR variables. +.sp +.in +2 +.nf +\fBchar *boolnames, *boolcodes, *boolfnames +char *numnames, *numcodes, *numfnames +char *strnames, *strcodes, *strfnames\fR +.fi +.in -2 + +.sp +.LP +The \fBtparm()\fR function instantiates a parameterized string using nine +arguments. The string is suitable for output processing by \fBtputs()\fR. +.SH RETURN VALUES +.sp +.LP +On success, the \fBtigetflg()\fR, \fBtigetnum()\fR, and \fBtigetstr()\fR +functions return the specified \fBterminfo\fR capability. +.sp +.LP +\fBtigetflag()\fR returns \(mi1 if \fIcapname\fR is not a Boolean capability. +.sp +.LP +\fBtigetnum()\fR returns \(mi2 if \fIcapname\fR is not a numeric capability. +.sp +.LP +\fBtigetstr()\fR returns \fB(char *)\fR\(mi1 if \fIcapname\fR is not a string +capability. +.sp +.LP +On success, the \fBtparm()\fR function returns \fIcap\fR in a static buffer +with the parameterization resolved. Otherwise, it returns a null pointer. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBtgetent\fR(3XCURSES), \fBterminfo\fR(4), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/typeahead.3xcurses b/usr/src/man/man3xcurses/typeahead.3xcurses new file mode 100644 index 0000000000..a5d8b83727 --- /dev/null +++ b/usr/src/man/man3xcurses/typeahead.3xcurses @@ -0,0 +1,83 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH typeahead 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +typeahead \- check for type-ahead characters +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBtypeahead\fR(\fBint\fR \fIfd\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIfd\fR\fR +.ad +.RS 6n +.rt +Is the file descriptor that is used to check for type-ahead characters. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBtypeahead()\fR function specifies the file descriptor (\fIfd\fR) to use +to check for type-ahead characters (characters typed by the user but not yet +processed by X/Open Curses). +.sp +.LP +X/Open Curses checks for type-ahead characters periodically while updating the +screen. If characters are found, the current update is postponed until the +next \fBrefresh\fR(3XCURSES) or \fBdoupdate\fR(3XCURSES). This speeds up +response to commands that have been typed ahead. Normally, the input file +pointer passed to \fBnewterm\fR(3XCURSES), or \fBstdin\fR in the case of +\fBinitscr\fR(3XCURSES), is used for type-ahead checking. +.sp +.LP +If \fIfd\fR is -1, no type-ahead checking is done. +.SH RETURN VALUES +.sp +.LP +On success, the \fBtypeahead()\fR function returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBgetch\fR(3XCURSES), \fBinitscr\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/unctrl.3xcurses b/usr/src/man/man3xcurses/unctrl.3xcurses new file mode 100644 index 0000000000..1a6f76151d --- /dev/null +++ b/usr/src/man/man3xcurses/unctrl.3xcurses @@ -0,0 +1,73 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH unctrl 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +unctrl \- generate printable representation of a character +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <unctrl.h> + +\fBchar *\fR\fBunctrl\fR(\fBchtype\fR \fIc\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIc\fR\fR +.ad +.RS 5n +.rt +Is a character. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBunctrl()\fR function generates a character string that is a printable +representation of \fIc\fR. If \fIc\fR is a control character,it is converted to +the \fB^\fR\fIX\fR notation. If \fIc\fR contains rendition information, the +effect is undefined. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, the \fBunctrl()\fR function returns the generated +string. Otherwise, it returns a null pointer. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBaddch\fR(3XCURSES), \fBaddstr\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBwunctrl\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/ungetch.3xcurses b/usr/src/man/man3xcurses/ungetch.3xcurses new file mode 100644 index 0000000000..39a95cd0c9 --- /dev/null +++ b/usr/src/man/man3xcurses/ungetch.3xcurses @@ -0,0 +1,92 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH ungetch 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +ungetch, unget_wch \- push character back onto the input queue +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBungetch\fR(\fBint\fR \fIch\fR); +.fi + +.LP +.nf +\fBint\fR \fBunget_wch\fR(\fBconst wchar_t\fR \fIwch\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIch\fR\fR +.ad +.RS 7n +.rt +Is the single byte character to be put back in the input queue for the next +call to \fBgetch\fR(3XCURSES). +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwch\fR\fR +.ad +.RS 7n +.rt +Is the wide character to be put back in the input queue for the next call to +\fBget_wch\fR(3XCURSES). +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBungetch()\fR function pushes \fIch\fR back onto the input queue until +the next call to \fBgetch()\fR. +.sp +.LP +The \fBunget_wch()\fR function is similar to \fBungetch()\fR except that +\fIch\fR can be of type \fBwchar_t\fR. +.SH RETURN VALUES +.sp +.LP +On success, these functions return \fBOK\fR. Otherwise, they return \fBERR\fR. +.SH ERRORS +.sp +.LP +None. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBget_wch\fR(3XCURSES), \fBgetch\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/use_env.3xcurses b/usr/src/man/man3xcurses/use_env.3xcurses new file mode 100644 index 0000000000..0527a9023a --- /dev/null +++ b/usr/src/man/man3xcurses/use_env.3xcurses @@ -0,0 +1,78 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH use_env 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +use_env \- specify source of screen size information +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBvoid\fR \fBuse_env\fR(\fBbool\fR \fIboolval\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIboolval\fR\fR +.ad +.RS 11n +.rt +Is a Boolean expression. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBuse_env()\fR function specifies the technique by which the +implementation determines the size of the screen. If \fIboolval\fR is +\fBFALSE\fR, the implementation uses the values of \fIlines\fR and +\fIcolumns\fR specified in the \fBterminfo\fR database. If \fIboolval\fR is +\fBTRUE\fR, the implementation uses the \fBLINES\fR and \fBCOLUMNS\fR +environmental variables. The initial value is \fBTRUE\fR. +.sp +.LP +Any call to \fBuse_env()\fR must precede calls to \fBinitscr\fR(3XCURSES), +\fBnewterm\fR(3XCURSES), or \fBsetupterm\fR(3XCURSES). +.SH RETURN VALUES +.sp +.LP +The \fBuse_env()\fR function does not return a value. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdel_curterm\fR(3XCURSES), \fBinitscr\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/vidattr.3xcurses b/usr/src/man/man3xcurses/vidattr.3xcurses new file mode 100644 index 0000000000..368e8a3c9f --- /dev/null +++ b/usr/src/man/man3xcurses/vidattr.3xcurses @@ -0,0 +1,165 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH vidattr 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +vidattr, vid_attr, vidputs, vid_puts \- output attributes to the terminal +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBint\fR \fBvidattr\fR(\fBchtype\fR \fIattr\fR); +.fi + +.LP +.nf +\fBint\fR \fBvid_attr\fR(\fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor_pair_number\fR, \fBvoid *\fR\fIopt\fR); +.fi + +.LP +.nf +\fBint\fR \fBvidputs\fR(\fBchtype\fR \fIattr\fR, \fBint (*\fR\fIputfunc\fR) (int)); +.fi + +.LP +.nf +\fBint\fR \fBvid_puts\fR(\fBattr_t\fR \fIattr\fR, \fBshort\fR \fIcolor_pair_number\fR, \fBvoid *\fR\fIopt\fR, + \fBint (*\fR\fIputfunc\fR) (int)); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIattr\fR\fR +.ad +.RS 21n +.rt +Is the rendition of the foreground window. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIcolor_pair_number\fR\fR +.ad +.RS 21n +.rt +Is a color pair. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIopt\fR\fR +.ad +.RS 21n +.rt +Is reserved for future use. Currently, this must be a null pointer. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIputfunc\fR\fR +.ad +.RS 21n +.rt +Is a user-supplied output function. +.RE + +.SH DESCRIPTION +.sp +.LP +These functions output commands to the terminal that change the terminal's +attributes. +.sp +.LP +If the \fBterminfo\fR database indicates that the terminal in use can display +characters in the rendition specified by \fIattr\fR, then \fBvidattr()\fR +outputs one or more commands to request that the terminal display subsequent +characters in that rendition. The function outputs by calling +\fBputchar\fR(3C). The \fBvidattr()\fR function neither relies on your updates +the model which Curses maintains of the prior rendition mode. +.sp +.LP +The \fBvidputs()\fR function computes the terminal output string that +\fBvidattr()\fR does, based on \fIattr\fR, but \fBvidputs()\fR outputs by +calling the user-supplied function \fIputfunc\fR. The \fBvid_attr()\fR and +\fBvid_puts()\fR functions correspond to \fBvidattr()\fR and \fBvidputs()\fR +respectively, but take a set of arguments, one of type \fBattr_t\fR for the +attributes, one of type \fBshort\fR for the color pair number, and a \fBvoid +*\fR, and thus support the attribute constants with the \fBWA_\fR prefix. +.sp +.LP +The \fIopts\fR argument is reserved for definition in a future release. +Currently, it is implemented as a null pointer. +.sp +.LP +The user-supplied function \fIputfunc\fR (which can be specified as an argument +to either \fBvidputs()\fR or \fBvid_puts()\fR) is either \fBputchar()\fR or +some other function with the same prototype. Both the \fBvidputs()\fR and +\fBvid_puts()\fR functions ignore the return value of \fIputfunc\fR. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, these functions return \fBOK\fR. Otherwise, they +return \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +After use of any of these functions, the model Curses maintains of the state of +the terminal might not match the actual state of the terminal. The application +should touch and refresh the window before resuming conventional use of Curses. +.sp +.LP +Of these functions requires that the application contain so much information +about a particular class of terminal that it defeats the purpose of using +Curses. +.sp +.LP +On some terminals, a command to change rendition conceptually occupies space in +the screen buffer (with or without width). Thus, a command to set the terminal +to a new rendition would change the rendition of some characters already +displayed. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBdoupdate\fR(3XCURSES), \fBis_linetouched\fR(3XCURSES), +\fBlibcurses\fR(3XCURSES), \fBputchar\fR(3C), \fBtigetflag\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/vw_printw.3xcurses b/usr/src/man/man3xcurses/vw_printw.3xcurses new file mode 100644 index 0000000000..4a6e05225c --- /dev/null +++ b/usr/src/man/man3xcurses/vw_printw.3xcurses @@ -0,0 +1,102 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH vw_printw 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +vw_printw \- print formatted output in window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <stdarg.h> +#include <curses.h> + +\fBint\fR \fBvw_printw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fBva_list\fR \fIvarglist\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIfmt\fR\fR +.ad +.RS 12n +.rt +Is a \fBprintf()\fR format string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIvarglist\fR\fR +.ad +.RS 12n +.rt +Is a pointer to a list of parameters. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 12n +.rt +Is a pointer to the window in which the string is to be written. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBvw_printw()\fR function achieves the same effect as +\fBwprintw\fR(3XCURSES) using a variable argument list. The third argument is a +\fBva_list\fR, as defined in <\fBstdarg.h\fR>. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, \fBvw_printw()\fR returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +The \fBvw_printw()\fR function is preferred over \fBvwprintw\fR(3XCURSES). The +use of the \fBvwprintw()\fR and \fBvw_printw()\fR in the same file will not +work, due to the requirements to include <\fBvarargs.h\fR> and +<\fBstdarg.h\fR>, which both contain definitions of \fBva_list\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBmvprintw\fR(3XCURSES), \fBprintf\fR(3C), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/vw_scanw.3xcurses b/usr/src/man/man3xcurses/vw_scanw.3xcurses new file mode 100644 index 0000000000..32940a11c7 --- /dev/null +++ b/usr/src/man/man3xcurses/vw_scanw.3xcurses @@ -0,0 +1,102 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH vw_scanw 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +vw_scanw \- convert formatted input from a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <stdarg.h> +#include <curses.h> + +\fBint\fR \fBvw_scanw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fBva_list\fR \fIvarglist\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIfmt\fR\fR +.ad +.RS 12n +.rt +Is a \fBscanf()\fR format string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIvarglist\fR\fR +.ad +.RS 12n +.rt +Is a pointer to a list of parameters. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 12n +.rt +Is a pointer to the window in which the character is to be read. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBvw_scanw()\fR function achieves the same effect as +\fBwscanw\fR(3XCURSES) using a variable argument list. The third argument is a +\fBva_list\fR, as defined in <\fBstdarg.h\fR>. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, \fBvw_scanw()\fR returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +The \fBvw_scanw()\fR function is preferred over \fBvwscanw\fR(3XCURSES). The +use of the \fBvwscanw()\fR and \fBvw_scanw()\fR in the same file will not work, +due to the requirements to include <\fBvarargs.h\fR> and <\fBstdarg.h\fR>, +which both contain definitions of \fBva_list\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBmvscanw\fR(3XCURSES), \fBscanf\fR(3C), +\fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/vwprintw.3xcurses b/usr/src/man/man3xcurses/vwprintw.3xcurses new file mode 100644 index 0000000000..035d781ad1 --- /dev/null +++ b/usr/src/man/man3xcurses/vwprintw.3xcurses @@ -0,0 +1,103 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH vwprintw 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +vwprintw \- print formatted output in window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <varargs.h> +#include <curses.h> + +\fBint\fR \fBvwprintw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fBva_list\fR \fIvarglist\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIfmt\fR\fR +.ad +.RS 12n +.rt +Is a \fBprintf()\fR format string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIvarglist\fR\fR +.ad +.RS 12n +.rt +Is a pointer to a list of parameters. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 12n +.rt +Is a pointer to the window in which the string is to be written. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBvwprintw()\fR function achieves the same effect as +\fBwprintw\fR(3XCURSES) using a variable argument list. The third argument is a +\fBva_list\fR, as defined in <\fBvarargs.h\fR>. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, \fBvwprintw()\fR returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +The \fBvwprintw()\fR function is deprecated; the \fBvw_printw\fR(3XCURSES) +function is preferred. The use of the \fBvwprintw()\fR and \fBvw_printw()\fR in +the same file will not work, due to the requirements to include +<\fBvarargs.h\fR> and <\fBstdarg.h\fR>, which both contain definitions of +\fBva_list\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBmvprintw\fR(3XCURSES), \fBprintf\fR(3C), +\fBvw_printw\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/vwscanw.3xcurses b/usr/src/man/man3xcurses/vwscanw.3xcurses new file mode 100644 index 0000000000..568da57d62 --- /dev/null +++ b/usr/src/man/man3xcurses/vwscanw.3xcurses @@ -0,0 +1,103 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH vwscanw 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +vwscanw \- convert formatted input from a window +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <varargs.h> +#include <curses.h> + +\fBint\fR \fBvwscanw\fR(\fBWINDOW *\fR\fIwin\fR, \fBchar *\fR\fIfmt\fR, \fBva_list\fR \fIvarglist\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIfmt\fR\fR +.ad +.RS 12n +.rt + Is a \fBscanf()\fR format string. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIvarglist\fR\fR +.ad +.RS 12n +.rt +Is a pointer to a list of parameters. +.RE + +.sp +.ne 2 +.mk +.na +\fB\fIwin\fR\fR +.ad +.RS 12n +.rt +Is a pointer to the window in which the character is to be read. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBvwscanw()\fR function achieves the same effect as \fBwscanw\fR(3XCURSES) +using a variable argument list. The third argument is a \fBva_list\fR, as +defined in <\fBvarargs.h\fR>. +.SH RETURN VALUES +.sp +.LP +Upon successful completion, \fBvwscanw()\fR returns \fBOK\fR. Otherwise, it +returns \fBERR\fR. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH USAGE +.sp +.LP +The \fBvwscanw()\fR function is deprecated; the \fBvw_scanw\fR(3XCURSES) +function is preferred. The use of the \fBvwscanw()\fR and \fBvw_scanw()\fR in +the same file will not work, due to the requirements to include +<\fBvarargs.h\fR> and <\fBstdarg.h\fR>, which both contain definitions of +\fBva_list\fR. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBlibcurses\fR(3XCURSES), \fBmvscanw\fR(3XCURSES), \fBscanf\fR(3C), +\fBvw_scanw\fR(3XCURSES), \fBattributes\fR(5), \fBstandards\fR(5) diff --git a/usr/src/man/man3xcurses/wunctrl.3xcurses b/usr/src/man/man3xcurses/wunctrl.3xcurses new file mode 100644 index 0000000000..30c6bcbc01 --- /dev/null +++ b/usr/src/man/man3xcurses/wunctrl.3xcurses @@ -0,0 +1,86 @@ +'\" te +.\" Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1999, Sun Microsystems, Inc. All Rights Reserved +.\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License. +.\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License. +.\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner] +.TH wunctrl 3XCURSES "5 Jun 2002" "SunOS 5.11" "X/Open Curses Library Functions" +.SH NAME +wunctrl \- generate printable representation of a wide character +.SH SYNOPSIS +.LP +.nf +\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-I\fR /usr/xpg4/include \fB -L \fR /usr/xpg4/lib \e +\fB -R \fR /usr/xpg4/lib \fB -lcurses \fR [ \fIlibrary\fR... ] + +\fBc89\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lcurses\fR [ \fIlibrary\fR... ] + +#include <curses.h> + +\fBwchar_t *\fR\fBwunctrl\fR(\fBcchar_t *\fR\fIwc\fR); +.fi + +.SH PARAMETERS +.sp +.ne 2 +.mk +.na +\fB\fIwc\fR\fR +.ad +.RS 6n +.rt +Is a pointer to the wide character. +.RE + +.SH DESCRIPTION +.sp +.LP +The \fBwunctrl()\fR function converts the a wide character string that is a +printable representation of the wide character \fIwc\fR. +.sp +.LP +This function also performs the following processing on the input argument: +.RS +4 +.TP +.ie t \(bu +.el o +Control characters are converted to the \fB^\fR\fIX\fR notation +.RE +.RS +4 +.TP +.ie t \(bu +.el o +Any rendition information is removed. +.RE +.SH RETURN VALUES +.sp +.LP +Upon successful completion, the \fBwunctrl()\fR function returns the generated +string. Otherwise, it returns a null pointer. +.SH ERRORS +.sp +.LP +No errors are defined. +.SH ATTRIBUTES +.sp +.LP +See \fBattributes\fR(5) for descriptions of the following attributes: +.sp + +.sp +.TS +tab() box; +cw(2.75i) |cw(2.75i) +lw(2.75i) |lw(2.75i) +. +ATTRIBUTE TYPEATTRIBUTE VALUE +_ +Interface StabilityStandard +_ +MT-LevelUnsafe +.TE + +.SH SEE ALSO +.sp +.LP +\fBkeyname\fR(3XCURSES), \fBlibcurses\fR(3XCURSES), \fBunctrl\fR(3XCURSES), +\fBattributes\fR(5), \fBstandards\fR(5) |