diff options
Diffstat (limited to 'upstream/archlinux/man3/curs_print.3x')
| -rw-r--r-- | upstream/archlinux/man3/curs_print.3x | 72 |
1 files changed, 72 insertions, 0 deletions
diff --git a/upstream/archlinux/man3/curs_print.3x b/upstream/archlinux/man3/curs_print.3x new file mode 100644 index 00000000..31c7dc46 --- /dev/null +++ b/upstream/archlinux/man3/curs_print.3x @@ -0,0 +1,72 @@ +.\"*************************************************************************** +.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 1998-2010,2017 Free Software Foundation, Inc. * +.\" * +.\" Permission is hereby granted, free of charge, to any person obtaining a * +.\" copy of this software and associated documentation files (the * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id: curs_print.3x,v 1.19 2022/02/12 20:05:11 tom Exp $ +.TH curs_print 3X "" +.SH NAME +\fBmcprint\fP \- ship binary data to printer +.SH SYNOPSIS +\fB#include <curses.h>\fP +.sp +\fBint mcprint(char *\fIdata\fB, int \fIlen\fB);\fR +.SH DESCRIPTION +This function uses the \fBmc5p\fP or \fBmc4\fP and \fBmc5\fP capabilities, +if they are present, to ship given data to a printer attached to the terminal. +.PP +Note that the \fBmcprint\fP code has no way to do flow control with the printer +or to know how much buffering it has. +Your application is responsible for +keeping the rate of writes to the printer below its continuous throughput rate +(typically about half of its nominal cps rating). +Dot-matrix printers and +6-page-per-minute lasers can typically handle 80cps, so a good conservative +rule of thumb is to sleep for a second after shipping each 80-character line. +. +.SH RETURN VALUE +The \fBmcprint\fP function returns \fBERR\fP if the write operation aborted +for some reason. +In this case, \fBerrno\fP will contain either an error associated +with \fBwrite\fP(2) or one of the following: +.TP 5 +ENODEV +Capabilities for printer redirection do not exist. +.TP 5 +ENOMEM +Couldn't allocate sufficient memory to buffer the printer write. +.PP +When \fBmcprint\fP succeeds, it returns the number of characters actually +sent to the printer. +.SH PORTABILITY +The \fBmcprint\fP call was designed for \fBncurses\fP(3X), and is not found +in SVr4 curses, 4.4BSD curses, or any other previous version of curses. +.SH BUGS +Padding in the \fBmc5p\fP, \fBmc4\fP and \fBmc5\fP capabilities will not be +interpreted. +.SH SEE ALSO +\fBcurses\fP(3X) |