man/cups-driverd.man.in

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\"   cups-driverd man page for CUPS.
   5 .\"
   6 .\"   Copyright 2007-2013 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 "CUPS" "8 July 2013" "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 \fIlimit\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/usr/share/cups/model\fR directory or programs under the
  46 \fI/usr/lib/cups/driver\fR or \fI/usr/libexec/cups/driver\fR (OS X) directories.
  47 Static PPD files must conform to the Adobe PPD File Format Specification version
  48 4.3 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 .SS DRIVER PROGRAMS
  52 Driver programs provide a  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 .PP
  63 Driver programs MUST NOT query hardware or make other long-term operations that
  64 would delay the return of a driver list. See the NOTES section below for
  65 specific recommendations.
  66 .SS LISTING FILES (drivername list)
  67 When run with the single argument "list", the program must list
  68 the available PPD files it can generate to stdout using the
  69 following format:
  70 .nf
  71     "drivername:ppdname" language "make" "make and model"
  72     "drivername:ppdname" language "make" "make and model" "1284 device id"
  73     "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)"
  74     "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version"
  75     "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" "type"
  76 .fi
  77 .LP
  78 \fIDrivername\fR is the name of the driver program. \fIPpdname\fR
  79 is the name used to select the given driver. \fILanguage\fR is
  80 the locale associated with the default language of the PPD file,
  81 typically "en". \fIMake\fR is the Manufacturer name from the PPD
  82 file. \fIMake and model\fR is the NickName name from the PPD
  83 file. \fI1284 device id\fR is the 1284DeviceId from the PPD file,
  84 if any. \fI(PPD product)\fR is the Product string as it would appear in the PPD
  85 file or from a PostScript query. \fIPostScript version\fR is the PSVersion
  86 string as it would appear in the PPD file or from a PostScript query. \fIType\fR
  87 is "postscript" for PostScript printers, "pdf" for PDF printers, "raster" for
  88 raster printers, or "fax" for facsimile devices.
  89 .SS WRITING FILES (drivername cat ppdname)
  90 When the driver program is run with the "cat ppdname" arguments,
  91 it must write the named PPD file to stdout, uncompressed. If the
  92 named PPD file does not exist, the driver program must not write
  93 any output to stdout and report the error to stderr instead.
  94 .SS DRIVER ERROR MESSAGES
  95 Error messages can be relayed back to \fIcupsd\fR by writing them
  96 to stderr. The following prefixes are recognized:
  97 .TP 5
  98 DEBUG: [drivername]
  99 .br
 100 Debugging messages
 101 .TP 5
 102 ERROR: [drivername]
 103 .br
 104 Error messages
 105 .TP 5
 106 INFO: [drivername]
 107 .br
 108 Informational messages
 109 .SH NOTES
 110 Due to performance considerations, driver programs have been officially
 111 deprecated and should not be used for new development. Currently only the
 112 CUPS web interface and \fIlpinfo(8)\fR command will request lists from all
 113 driver programs.
 114 .SH SEE ALSO
 115 cupsd(8), cupsd.conf(5), cupstestppd(1), lpinfo(8),
 116 .br
 117 http://localhost:631/help
 118 .SH COPYRIGHT
 119 Copyright 2007-2013 by Apple Inc.
 120 .\"
 121 .\" End of "$Id$".
 122 .\"