System Administration Guide
Chapter 4, Managing printers and print jobs

Creating printer interface scripts

Creating printer interface scripts

If you have a printer that is not supported by simply adding an entry to the terminfo database, or if your printing needs are not supported by the standard or other interface scripts provided in /usr/spool/lp/model, you can create your own printer interface script. 

To create a customized interface script:

  1. Start with the standard interface script (or one of the other scripts in /usr/spool/lp/model) and modify it, rather than starting from scratch. For example:

    cd /usr/spool/lp/model
    cp standard okidatanew

  2. Make sure that the custom interface script sets the proper stty modes (terminal characteristics such as baud rate or output options). Look for the section that begins with this line:
       ## Initialize the printer port
    
    Modify the code in the standard interface script. It sets both the default modes and the adjusted modes given by the print service or the user with a line like:

    stty mode options 0<&1

    This command line takes the standard input for the stty command from the printer port. For example, this stty command line sets the baud rate to 1200bps and sets some of the option modes: 

    stty -parenb -parodd 1200 cs8 cread clocal ixon 0<&1

  3. Set the hardware flow control printer port characteristic. The standard interface script does not set hardware flow control. This is set according to your computer hardware. The code for the standard interface script suggests where to set this and other printer port characteristics. Look for the section that begins with this line:
       # Here you may want to add other port initialization code.
    

  4. Because different printers have different numbers of columns, make sure the header and trailer for your interface script correspond to your printer. The standard interface script prints a banner that fits on an 80-column page (except for the user's title, which may be longer). Look for the section in the code for the standard interface script that begins with this line:
       ## Print the banner page
    

  5. Specify that the custom interface script print all user-related error messages to the standard output or to the standard error. The print service prints standard output errors on the page and mails standard error to the user.

  6. Specify that when printing is complete, the interface script exits with a code that tells the status of the print job. Table 4-6, ``Exit codes'', describes how the print service interprets exit codes.

    One way of alerting the administrator to a printer fault is to exit with a code of 129. Unfortunately, if the interface script exits, the print service reprints the print job from the beginning once the fault is cleared. To get an alert to the administrator without reprinting the entire job, specify that the interface script send a fault message to the print service, but wait for the fault to clear. When the fault clears, the interface script resumes printing the job. When finished printing, the interface script can exit with zero as if the fault never occurred. An added advantage is that the interface script can detect when the fault is cleared automatically so that the administrator does not have to reenable the printer.

    To specify that fault messages be sent to the print service, use lp.tell(ADM). The standard printer interface code calls lp.tell(ADM) with the LPTELL shell variable. The lp.tell program sends its standard input to the print service. The print service forwards the message as an alert to the administrator. If its standard input is empty, lp.tell does not initiate an alert. Examine the code immediately following these comments in the standard interface script for an example of how to use the lp.tell (LPTELL) program:

       # Here's where we set up the $LPTELL program to capture
       # fault messages.
       #
       # Here's where we print the file.
    
    With the special exit code 129 or lp.tell, there is no longer the need for the interface script to disable the printer itself. Your interface script can disable the printer directly, but doing so overrides the fault-alerting mechanism. Alerts are sent only if the print service detects that the printer has faulted and the special exit code and lp.tell program are its main detection tools.

    If the print service has to interrupt the printing of a file at any time, it kills the interface script with a signal 15 (see the signal(S) and kill(C) manual pages for more information).

    If the interface script dies from receipt of any other signal, the print service assumes that future print jobs are not affected and continues to use the printer. The print service notifies the person who submitted the print job that the job did not finish successfully.

    The signals SIGHUP, SIGINT, SIGQUI, and SIGPIP (trap numbers 1, 2, 3, and 13) start out being ignored when the interface is invoked. The standard interface script changes this to trap these signals at appropriate times, interprets these signals to mean that the printer has a problem, and issues a fault.



Table 4-6 Exit codes

 ---------------------------------------------------
 Code       Meaning to the print service
 ---------------------------------------------------
 0          The print job completed successfully.
            If a printer fault occurred, it was
            cleared.
 1 to 127   The print service encountered a problem
            in printing the job (for example, there
            were too many nonprintable characters or
            the job exceeded the printer's
            capabilities).  This problem does not
            affect future print jobs.  The print
            service should notify the person who
            submitted the print job (via write(C) or
            mail(C) that an error occurred in
            printing the job.  If a printer fault
            occurred, it was cleared.
 128        Reserved for internal use by the print
            service.  Interface scripts must not
            exit with this code.
 129        The print service encountered a printer
            fault in printing the job.  This problem
            affects future print jobs.  If the fault
            recovery for the printer directs the
            print service to wait for the
            administrator to fix the problem, the
            print service should disable the
            printer.  If the fault recovery is to
            continue printing, the print service
            should not disable the printer, but try
            printing again in a few minutes.
 > 129      Reserved for internal use by the print
            service.  Interface scripts must not
            exit with codes in this range.

See also: