.\" $OpenBSD: curs_print.3,v 1.4 1997/12/14 23:15:41 millert Exp $
.\" Id: curs_print.3x,v 1.2 1997/12/06 22:07:19 tom Exp $
.TH curs_print 3 ""
.SH NAME
\fBmcprint\fR - ship binary data to printer
.SH SYNOPSIS
\fB#include <curses.h>\fR

\fBint mcprint(char *data, int len);\fR
.SH DESCRIPTION
This function uses the \fBmc5p\fR or \fBmc4\fR and \fBmc5\fR capabilities,
if they are present, to ship given data to a printer attached to the terminal.

Note that the \fBmcprint\fR 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\fR function returns \fBERR\fR if the write operation aborted 
for some reason.  In this case, errno will contain either an error associated
with \fBwrite(2)\fR or one of the following:
.TP 5
ENODEV
Capabilities for printer redirection don't exist.
.TP 5
ENOMEM
Couldn't allocate sufficient memory to buffer the printer write.

When \fBmcprint\fR succeeds, it returns the number of characters actually
sent to the printer.
.SH PORTABILITY
The \fBmcprint\fR call was designed for \fBcurses\fR(3), and is not found
in SVr4 curses, 4.4BSD curses, or any other previous version of curses.
.SH BUGS
Padding in the \fBmc5p\fR, \fBmc4\fR and \fBmc5\fR capabilities will not be
interpreted.
.SH SEE ALSO
\fBcurses\fR(3)\fR
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End: