test/ippserver.man

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