1.\" $NetBSD: curses_print.3,v 1.6 2003/04/16 13:35:01 wiz Exp $ 2.\" 3.\" Copyright (c) 2002 4.\" Brett Lymn (blymn@NetBSD.org, brett_lymn@yahoo.com.au) 5.\" 6.\" This code is donated to the NetBSD Foundation by the Author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.\" 33.Dd August 12, 2002 34.Dt CURSES_PRINT 3 35.Os 36.Sh NAME 37.Nm curses_print , 38.Nm printw , 39.Nm wprintw , 40.Nm mvprintw , 41.Nm mvwprintw , 42.Nm unctrl 43.Nd curses print formatted strings on windows routines 44.Sh LIBRARY 45.Lb libcurses 46.Sh SYNOPSIS 47.In curses.h 48.Ft int 49.Fn printw "const char *fmt" "..." 50.Ft int 51.Fn wprintw "WINDOW *win" "const char *fmt" "..." 52.Ft int 53.Fn mvprintw "int y" "int x" "const char *fmt" "..." 54.Ft int 55.Fn mvwprintw "WINDOW *win" "int y" "int x" "const char *fmt" "..." 56.Ft char * 57.Fn unctrl "chtype ch" 58.Sh DESCRIPTION 59These functions print formatted strings on 60.Dv stdscr 61or on the specified window. 62.Pp 63The 64.Fn printw 65function formats and prints its arguments on 66.Dv stdscr . 67The behaviour is the same as that of 68.Fn printf . 69.Pp 70The 71.Fn wprintw 72function is the same as the 73.Fn printw 74function, excepting that the resulting output is printed on the window 75specified by 76.Fa win . 77.Pp 78The 79.Fn mvprintw 80and 81.Fn mvwprintw 82functions are the same as the 83.Fn printw 84and 85.Fn wprintw 86functions, respectively, excepting that 87.Fn wmove 88is called to move the cursor to the position specified by 89.Fa y , 90.Fa x 91before the output is printed on the window. 92.Pp 93The 94.Fn unctrl 95function returns a printable string representation of the character 96.Fa ch . 97If 98.Fa ch 99is a control character then it will be converted to the form ^Y. 100.Sh RETURN VALUES 101Functions returning pointers will return 102.Dv NULL 103if an error is detected. 104The functions that return an int will return one of the following 105values: 106.Pp 107.Bl -tag -width ERR -compact 108.It Er OK 109The function completed successfully. 110.It Er ERR 111An error occurred in the function. 112.El 113.Sh SEE ALSO 114.Xr curses_cursor 3 , 115.Xr curses_scanw 3 , 116.Xr printf 3 117.Sh STANDARDS 118The 119.Nx 120Curses library complies with the X/Open Curses specification, part of the 121Single Unix Specification. 122.Sh HISTORY 123The Curses package appeared in 124.Bx 4.0 . 125