man/ippeveprinter.man

   1 .\"
   2 .\" ippeveprinter man page for CUPS.
   3 .\"
   4 .\" Copyright © 2014-2019 by Apple Inc.
   5 .\"
   6 .\" Licensed under Apache License v2.0.  See the file "LICENSE" for more
   7 .\" information.
   8 .\"
   9 .TH ippeveprinter 1 "CUPS" "20 March 2019" "Apple Inc."
  10 .SH NAME
  11 ippeveprinter \- an ipp everywhere printer application for cups
  12 .SH SYNOPSIS
  13 .B ippeveprinter
  14 [
  15 .B \-2
  16 ] [
  17 .B \-M
  18 .I manufacturer
  19 ] [
  20 .B \-P
  21 ] [
  22 .B \-c
  23 .I command
  24 ] [
  25 .B \-d
  26 .I spool-directory
  27 ] [
  28 .B \-f
  29 .I type/subtype[,...]
  30 ] [
  31 .B \-h
  32 ] [
  33 .B \-i
  34 .I iconfile.png
  35 ] [
  36 .B \-k
  37 ] [
  38 .B \-l
  39 .I location
  40 ] [
  41 .B \-m
  42 .I model
  43 ] [
  44 .B \-n
  45 .I hostname
  46 ] [
  47 .B \-p
  48 .I port
  49 ] [
  50 .B \-r
  51 .I subtype
  52 ] [
  53 .B \-s
  54 .I speed[,color-speed]
  55 ] [
  56 .B \-v[vvv]
  57 ]
  58 .I service-name
  59 .SH DESCRIPTION
  60 .B ippeveprinter
  61 is a simple Internet Printing Protocol (IPP) server conforming to the IPP Everywhere (PWG 5100.14) specification. It can be used to test client software or act as a very basic print server that runs a command for every job that is printed.
  62 .SH OPTIONS
  63 The following options are recognized by
  64 .B ippeveprinter:
  65 .TP 5
  66 .B \-2
  67 Report support for two-sided (duplex) printing.
  68 .TP 5
  69 \fB\-M \fImanufacturer\fR
  70 Set the manufacturer of the printer.
  71 The default is "Test".
  72 .TP 5
  73 .B \-P
  74 Report support for PIN printing.
  75 .TP 5
  76 \fB\-c \fIcommand\fR
  77 Run the specified command for each document that is printed.
  78 .TP 5
  79 \fB\-d \fIspool-directory\fR
  80 Specifies the directory that will hold the print files.
  81 The default is a directory under the user's current temporary directory.
  82 .TP 5
  83 \fB\-f \fItype/subtype[,...]\fR
  84 Specifies a list of MIME media types that the server will accept.
  85 The default is "application/pdf,image/jpeg,image/pwg-raster".
  86 .TP 5
  87 .B \-h
  88 Shows program help.
  89 .TP 5
  90 \fB\-i \fIiconfile.png\fR
  91 Specifies the printer icon file for the server.
  92 The default is "printer.png".
  93 .TP 5
  94 .B \-k
  95 Keeps the print documents in the spool directory rather than deleting them.
  96 .TP 5
  97 \fB\-l \fIlocation\fR
  98 Specifies the human-readable location string that is reported by the server.
  99 The default is the empty string.
 100 .TP 5
 101 \fB\-m \fImodel\fR
 102 Specifies the model name of the printer.
 103 The default is "Printer".
 104 .TP 5
 105 \fB\-n \fIhostname\fR
 106 Specifies the hostname that is reported by the server.
 107 The default is the name returned by the
 108 .BR hostname (1)
 109 command.
 110 .TP 5
 111 \fB\-p \fIport\fR
 112 Specifies the port number to listen on.
 113 The default is a user-specific number from 8000 to 8999.
 114 .TP 5
 115 \fB\-r \fIsubtype\fR
 116 Specifies the Bonjour subtype(s) to advertise.
 117 Separate multiple subtypes with a comma.
 118 The default is "_print".
 119 .TP 5
 120 \fB\-s \fIspeed[,color-speed]\fR
 121 Specifies the printer speed in pages per minute.
 122 If two numbers are specified and the second number is greater than zero, the server will report support for color printing.
 123 The default is "10,0".
 124 .TP 5
 125 .B \-v[vvv]
 126 Be (very) verbose when logging activity to the standard output.
 127 .SH EXIT STATUS
 128 The
 129 .B ippeveprinter
 130 program returns 1 if it is unable to process the command-line arguments or register the IPP service.
 131 Otherwise
 132 .B ippeveprinter
 133 will run continuously until terminated.
 134 .SH CONFORMING TO
 135 The
 136 .B ippeveprinter
 137 program is unique to CUPS and conforms to the IPP Everywhere (PWG 5100.14) specification.
 138 .SH ENVIRONMENT
 139 .B ippeveprinter
 140 adds environment variables starting with "IPP_" for all IPP Job attributes in the print request.
 141 For example, when executing a command for an IPP Job containing the "media" Job Template attribute, the "IPP_MEDIA" environment variable will be set to the value of that attribute.
 142 .LP
 143 Enumerated values are converted to their keyword equivalents.
 144 For example, a "print-quality" Job Template attribute with a enum value of 3 will become the "IPP_PRINT_QUALITY" environment variable with a value of "draft".
 145 .SH EXAMPLES
 146 Run
 147 .B ippeveprinter
 148 with a service name of My Cool Printer:
 149 .nf
 150
 151     ippeveprinter "My Cool Printer"
 152 .fi
 153 .LP
 154 Run the
 155 .BR file (1)
 156 command whenever a job is sent to the server:
 157 .nf
 158
 159     ippeveprinter \-c file "My Cool Printer"
 160 .fi
 161 .SH SEE ALSO
 162 PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
 163 .SH COPYRIGHT
 164 Copyright \[co] 2007-2019 by Apple Inc.