man/cups-driverd.man.in

   1 .\"
   2 .\" "$Id: cups-driverd.man.in 6649 2007-07-11 21:46:42Z mike $"
   3 .\"
   4 .\"   cups-driverd man page for the Common UNIX Printing System (CUPS).
   5 .\"
   6 .\"   Copyright 2007 by Apple Inc.
   7 .\"   Copyright 1997-2006 by Easy Software Products.
   8 .\"
   9 .\"   These coded instructions, statements, and computer programs are the
  10 .\"   property of Apple Inc. and are protected by Federal copyright
  11 .\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
  12 .\"   which should have been included with this file.  If this file is
  13 .\"   file is missing or damaged, see the license at "http://www.cups.org/".
  14 .\"
  15 .TH cups-driverd 8 "Common UNIX Printing System" "12 February 2006" "Apple Inc."
  16 .SH NAME
  17 cups-driverd \- cups driver daemon
  18 .SH SYNOPSIS
  19 .B cups-driverd
  20 cat
  21 .I ppd-name
  22 .br
  23 .B cups-driverd
  24 list
  25 .I request_id limit options
  26 .SH DESCRIPTION
  27 \fIcups-driverd\fR shows or lists PPD files. It is run in
  28 response to CUPS-Add-Modify-Printer or CUPS-Get-Devices requests.
  29 The first form ("cups-driverd cat ppd-name") writes the named PPD
  30 file to stdout. The output format is an uncompressed PPD file.
  31 .LP
  32 The second form lists the available manufacturers or PPD files to
  33 stdout as indicated by the \fIoptions\fR argument. The output
  34 format is an IPP response message. The \fIrequest_id\fR argument
  35 is the request ID from the original IPP request, typically 1. The
  36 \Ilimit\fR argument is the limit value from the original IPP
  37 request - 0 means no limit. Finally, the \fIoptions\fR argument
  38 is a space-delimited list of attributes ("name=value name=value
  39 \...") that were passed in with the request. Currently
  40 \fIcups-driverd\fR looks for the \fIppd-make\fR and
  41 \fIrequested-attributes\fR attributes and tailors the output
  42 accordingly.
  43 .SH DRIVERS
  44 Drivers can be static PPD files under the
  45 \fI@CUPS_DATADIR@/model\fR directory or programs under the
  46 \fI@CUPS_SERVERBIN@/driver\fR directory. Static PPD files must
  47 conform to the Adobe PPD File Format Specification version 4.3
  48 and may be compressed using the \fIgzip(1)\fR program. Driver
  49 programs must implement the command-line interface shown in the
  50 next section.
  51 .Sh DRIVER PROGRAMS
  52 Driver programs provide an interface to dynamically-generated PPD
  53 files. The following arguments are currently defined:
  54 .TP 5
  55 drivername list
  56 .br
  57 Lists the supported PPD files to stdout.
  58 .TP 5
  59 drivername cat ppdname
  60 .br
  61 Writes the named PPD file to stdout.
  62 .Sh LISTING FILES (drivername list)
  63 When run with the single argument "list", the program must list
  64 the available PPD files it can generate to stdout using the
  65 following format:
  66 .nf
  67     "drivername:ppdname" language "make" "make and model" "1284 device id"
  68 .fi
  69 .LP
  70 \fIDrivername\fR is the name of the driver program. \fIPpdname\fR
  71 is the name used to select the given driver. \fILanguage\fR is
  72 the locale associated with the default language of the PPD file,
  73 typically "en". \fIMake\fR is the Manufacturer name from the PPD
  74 file. \fIMake and model\fR is the NickName name from the PPD
  75 file. \fI1284 device id\fR is the 1284DeviceId from the PPD file,
  76 if any.
  77 .Sh WRITING FILES (drivername cat ppdname)
  78 When the driver program is run with the "cat ppdname" arguments,
  79 it must write the named PPD file to stdout, uncompressed. If the
  80 named PPD file does not exist, the driver program must not write
  81 any output to stdout and report the error to stderr instead.
  82 .Sh DRIVER ERROR MESSAGES
  83 Error messages can be relayed back to \fIcupsd\fR by writing them
  84 to stderr. The following prefixes are recognized:
  85 .TP 5
  86 DEBUG: [drivername]
  87 .br
  88 Debugging messages
  89 .TP 5
  90 ERROR: [drivername]
  91 .br
  92 Error messages
  93 .TP 5
  94 INFO: [drivername]
  95 .br
  96 Informational messages
  97 .SH SEE ALSO
  98 cupsd(8), cupsd.conf(5), cupstestppd(1),
  99 .br
 100 http://localhost:631/help
 101 .SH COPYRIGHT
 102 Copyright 2007 by Apple Inc.
 103 .\"
 104 .\" End of "$Id: cups-driverd.man.in 6649 2007-07-11 21:46:42Z mike $".
 105 .\"