Printer backend's device driver interface program.
/usr/lpd/pio/etc/pioout [ -A BytesPrinted ] [ -B TotalBytes ] [ -C NumberCancelStrings ] [ -D CancelString ] [ -E Mask ] [ -F FormFeedString ] [ -I InterventionRequiredUser ] [ -K TextString ] [ -L TextString ] [ -N NumberFormFeedStrings ] [ -O OutFile ] [ -P PrefixFile ] [ -R ParseRoutine ] [ -S SuffixFile ] [ -W+ ]
The pioout command is at the end of pipelines invoked by the piobe command (the print job manager) to print a file or a burst page on a printer. It reads input data from standard input, the prefix file (if the -P flag is specified), and the suffix file (if the -S flag is specified), and then writes the data to the printer (or OutFile, if the -O flag is specified). Error conditions and situations where intervention is required (unless the -I flag is specified) are reported to the user who submitted the print job.
The values specified with the -A flag and the -B flag are used to periodically report to the qdaemon process the percentage of the print job that has completed. The -C flag and the -D flag specify the data string sent to the printer if the print job is canceled.
The -O flag is used to generate a header page and store it in a temporary file. The -P flag is then used to print the header page (that was saved in a temporary file) just prior to printing the print file.
The pioout command requires the following environment variables to be initialized:
| Item | Description |
|---|---|
| PIOTITLE | Title of the print job |
| PIODEVNAME | Device name |
| PIOQNAME | Print queue name |
| PIOQDNAME | Queue device name |
| PIOFROM | User who submitted the print job |
| PIOMAILONLY | If nonzero, message to user should always be mailed, not displayed. |
| PIOTERM | Overrides the terminal type assumed from the tty definition. This variable is only used for print jobs submitted to terminal-attached terminals. |
| Item | Description |
|---|---|
| -A BytesPrinted | Specifies the number of bytes already printed for the print job. |
| -B TotalBytes | Specifies the total number of bytes to be printed for the print job. |
| -C NumberCancelStrings | Specifies the number of times the string specified by the -D flag is to be sent to the printer when a print job is canceled. If this flag is not specified, the value is assumed to be 3168. |
| -D CancelString | Specifies the string to be sent to the printer when a print job is canceled. If the -D flag is not specified, the string is assumed to consist of 1 null character. |
| -E Mask | Specifies, as Mask, one or more device-driver error-flag names, separated by commas. If the mask is one returned by the ioctl subroutine with an LPQUERY command, the error condition indicated by the mask is ignored. Flag names can include LPST_ERROR, LPST_NOSLCT, and LPST_SOFT, and are defined in the /usr/include/sys/lpio.h file. |
| -F FormFeed String | Specifies the string to be sent to the printer to cause a form feed. If the -F flag is not specified, the string is assumed to be \014. |
| -I InterventionRequiredUser | Specifies the user to whom a message is to be sent when the
printer requires intervention. If this flag is not specified, the
message is sent to the user who submitted the print job. The InterventionRequiredUser parameter can be one or more user names, separated by commas. A null string represents the print job submitter. For example, the string ,jim@server02 causes intervention required messages to be sent to both the print job submitter and to user jim at node server02. |
| -K TextString | Specifies that messages sent by a PostScript printer will be discarded if they contain the specified text string. For example, if the TextString variable is warming up, messages that include the text warming up will be discarded. |
| -L TextString | Specifies that if a message received from a PostScript printer includes the specified text string, the text following this text string in the message will be sent to the intervention-required user specified by the -I flag. |
| -N NumberFormFeedStrings | Specifies the number of form-feed strings to be sent to the printer at the end of the input data stream. If this flag is not specified, the value is assumed to be zero. This flag is normally used only to align continuous forms after the printer has been idle, or to feed forms when the printer goes idle. |
| -O OutFile | Specifies that the output is sent to the specified file instead of being sent to the printer. |
| -P PrefixFile | Specifies the file sent to the printer before the first byte of the print file is sent. If the print job terminates before the first byte of the print file arrives, the prefix file is not sent. |
| -R ParseRoutine | Specifies the full path name of a routine to parse data read from the printer. An example of a parse routine is contained in the /usr/include/piostruct.h file. If the -R flag is not specified, a default parse routine is used. |
| -S SuffixFile | Specifies the file sent to the printer after the print file has been sent. If the print job terminates before the first byte of the print file arrives, the suffix file is not sent. |
| -W + | Specifies that EOF (hex 04) must be received from the printer in order to exit. |