X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_print.3x;h=101d2935e2965513e50dcca4b1c5ce0f7c9446c3;hp=7b781988fddbb905f3b75522b9e2ac97440a21b8;hb=HEAD;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/curs_print.3x b/man/curs_print.3x index 7b781988..3694beff 100644 --- a/man/curs_print.3x +++ b/man/curs_print.3x @@ -1,5 +1,6 @@ .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2023,2024 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,49 +27,63 @@ .\" authorization. * .\"*************************************************************************** .\" -.'" $Id: curs_print.3x,v 1.3 1998/03/11 21:12:53 juergen Exp $ -.TH curs_print 3X "" +.\" $Id: curs_print.3x,v 1.38 2024/03/16 15:35:01 tom Exp $ +.TH curs_print 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME -\fBmcprint\fR - ship binary data to printer +\fB\%mcprint\fP \- +write binary data to printer using \fIterminfo\fR capabilities .SH SYNOPSIS -\fB#include \fR - -\fBint mcprint(char *data, int len);\fR +.nf +\fB#include +.PP +\fBint mcprint(char *\fIdata\fP, int \fIlen\fP); +.fi .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. - -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 +.PP +Note that the \fB\%mcprint\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 \fB\%mcprint\fP function returns \fBERR\fP if the write operation aborted +for some reason. +In this case, \fB\%errno\fP will contain either an error associated +with \fBwrite\fP(2) or one of the following: .TP 5 -ENODEV -Capabilities for printer redirection don't exist. +\fBENODEV\fP +Capabilities for printer redirection do not exist. .TP 5 -ENOMEM +\fBENOMEM\fP Couldn't allocate sufficient memory to buffer the printer write. - -When \fBmcprint\fR succeeds, it returns the number of characters actually +.PP +When \fB\%mcprint\fP succeeds, it returns the number of characters actually sent to the printer. +.SH EXTENSIONS +\fB\%mcprint\fP was designed for +\fB\%ncurses\fP(3X), +and was not found in SVr4 +.IR curses , +4.4BSD +.IR curses , +or any other previous curses implementation. .SH PORTABILITY -The \fBmcprint\fR call was designed for \fBncurses\fR(3X), and is not found -in SVr4 curses, 4.4BSD curses, or any other previous version of curses. +Applications employing this +.I \%ncurses +extension should condition its use on the visibility of the +.B \%NCURSES_VERSION +preprocessor macro. .SH BUGS -Padding in the \fBmc5p\fR, \fBmc4\fR and \fBmc5\fR capabilities will not be -interpreted. +Padding in the +\fBmc5p\fP, +\fBmc4\fP, and +\fBmc5\fP capabilities is not interpreted. .SH SEE ALSO -\fBcurses\fR(3X)\fR -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +\fB\%curses\fP(3X)