X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fcurs_print.3x;h=31c7dc46ecd99bf2fa8346d59b8686c9ce82b10b;hb=c11444e368f1d5964bd0f81e6e3b0f8c8ccd09cc;hp=039f5b73f3216505f39be3984ae2c5edc4a4cca5;hpb=58552e8c761a70f8f0bd591fecdf576fa8216e3e;p=ncurses.git diff --git a/man/curs_print.3x b/man/curs_print.3x index 039f5b73..31c7dc46 100644 --- a/man/curs_print.3x +++ b/man/curs_print.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2017 Free Software Foundation, Inc. * +.\" 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 * @@ -26,29 +27,32 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_print.3x,v 1.11 2017/01/07 17:33:15 tom Exp $ +.\" $Id: curs_print.3x,v 1.19 2022/02/12 20:05:11 tom Exp $ .TH curs_print 3X "" .SH NAME -\fBmcprint\fR \- ship binary data to printer +\fBmcprint\fP \- ship binary data to printer .SH SYNOPSIS -\fB#include \fR +\fB#include \fP .sp -\fBint mcprint(char *data, int len);\fR +\fBint mcprint(char *\fIdata\fB, int \fIlen\fB);\fR .SH DESCRIPTION -This function uses the \fBmc5p\fR or \fBmc4\fR and \fBmc5\fR capabilities, +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\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 +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 +(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: +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. @@ -56,13 +60,13 @@ Capabilities for printer redirection do not exist. ENOMEM Couldn't allocate sufficient memory to buffer the printer write. .PP -When \fBmcprint\fR succeeds, it returns the number of characters actually +When \fBmcprint\fP succeeds, it returns the number of characters actually sent to the printer. .SH PORTABILITY -The \fBmcprint\fR call was designed for \fBncurses\fR(3X), and is not found +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\fR, \fBmc4\fR and \fBmc5\fR capabilities will not be +Padding in the \fBmc5p\fP, \fBmc4\fP and \fBmc5\fP capabilities will not be interpreted. .SH SEE ALSO -\fBcurses\fR(3X) +\fBcurses\fP(3X)