X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fcurs_print.3x;h=101d2935e2965513e50dcca4b1c5ce0f7c9446c3;hp=3325958eb48619bbfd8e3532a4f3cc1e30f37bec;hb=HEAD;hpb=31c4bcf3307145fc5368b4aaf15e41bdd66a984b diff --git a/man/curs_print.3x b/man/curs_print.3x index 3325958e..3694beff 100644 --- a/man/curs_print.3x +++ b/man/curs_print.3x @@ -1,5 +1,5 @@ .\"*************************************************************************** -.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" 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 * @@ -27,20 +27,23 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: curs_print.3x,v 1.25 2023/09/16 23:37:03 tom Exp $ -.TH curs_print 3X 2023-09-16 "ncurses 6.4" "Library calls" +.\" $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 \fB\%mcprint\fP \- write binary data to printer using \fIterminfo\fR capabilities .SH SYNOPSIS -\fB#include \fP -.sp -\fBint mcprint(char *\fIdata\fB, int \fIlen\fB);\fR +.nf +\fB#include +.PP +\fBint mcprint(char *\fIdata\fP, int \fIlen\fP); +.fi .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 +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 @@ -50,24 +53,37 @@ Dot-matrix printers and 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 +The \fB\%mcprint\fP function returns \fBERR\fP if the write operation aborted for some reason. -In this case, \fBerrno\fP will contain either an error associated +In this case, \fB\%errno\fP will contain either an error associated with \fBwrite\fP(2) or one of the following: .TP 5 -ENODEV +\fBENODEV\fP Capabilities for printer redirection do not exist. .TP 5 -ENOMEM +\fBENOMEM\fP Couldn't allocate sufficient memory to buffer the printer write. .PP -When \fBmcprint\fP succeeds, it returns the number of characters actually +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\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. +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\fP, \fBmc4\fP and \fBmc5\fP capabilities will not be -interpreted. +Padding in the +\fBmc5p\fP, +\fBmc4\fP, and +\fBmc5\fP capabilities is not interpreted. .SH SEE ALSO -\fBcurses\fP(3X) +\fB\%curses\fP(3X)