test/ippserver.man

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