[thirdparty/cups.git] / test / ippserver.man

.\"
.\" ippserver man page for CUPS.
.\"
.\" Copyright 2014 by Apple Inc.
.\"
.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more information.
.\"
.TH ippserver 1 "CUPS" "28 August 2014" "Apple Inc."
.SH NAME
ippserver \- a simple internet printing protocol server
.SH SYNOPSIS
.B ippserver
[
.B \-2
] [
.B \-M
.I manufacturer
] [
.B \-P
] [
.B \-c
.I command
] [
.B \-d
.I spool-directory
] [
.B \-f
.I type/subtype[,...]
] [
.B \-h
] [
.B \-i
.I iconfile.png
] [
.B \-k
] [
.B \-l
.I location
] [
.B \-m
.I model
] [
.B \-n
.I hostname
] [
.B \-p
.I port
] [
.B \-r
.I subtype
] [
.B \-s
.I speed[,color-speed]
] [
.B \-v[vvv]
]
.I service-name
.SH DESCRIPTION
.B ippserver
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.
.SH OPTIONS
The following options are recognized by
.B ippserver:
.TP 5
.B \-2
Report support for two-sided (duplex) printing.
.TP 5
\fB\-M \fImanufacturer\fR
Set the manufacturer of the printer.
The default is "Test".
.TP 5
.B \-P
Report support for PIN printing.
.TP 5
\fB\-c \fIcommand\fR
Run the specified command for each document that is printed.
.TP 5
\fB\-d \fIspool-directory\fR
Specifies the directory that will hold the print files.
The default is a directory under the user's current temporary directory.
.TP 5
\fB\-f \fItype/subtype[,...]\fR
Specifies a list of MIME media types that the server will accept.
The default is "application/pdf,image/jpeg,image/pwg-raster".
.TP 5
.B \-h
Shows program help.
.TP 5
\fB\-i \fIiconfile.png\fR
Specifies the printer icon file for the server.
The default is "printer.png".
.TP 5
.B \-k
Keeps the print documents in the spool directory rather than deleting them.
.TP 5
\fB\-l \fIlocation\fR
Specifies the human-readable location string that is reported by the server.
The default is the empty string.
.TP 5
\fB\-m \fImodel\fR
Specifies the model name of the printer.
The default is "Printer".
.TP 5
\fB\-n \fIhostname\fR
Specifies the hostname that is reported by the server.
The default is the name returned by the
.BR hostname (1)
command.
.TP 5
\fB\-p \fIport\fR
Specifies the port number to listen on.
The default is a user-specific number from 8000 to 8999.
.TP 5
\fB\-r \fIsubtype\fR
Specifies the Bonjour subtype(s) to advertise.
Separate multiple subtypes with a comma.
The default is "_print".
.TP 5
\fB\-s \fIspeed[,color-speed]\fR
Specifies the printer speed in pages per minute.
If two numbers are specified and the second number is greater than zero, the server will report support for color printing.
The default is "10,0".
.TP 5
.B \-v[vvv]
Be (very) verbose when logging activity to the standard output.
.SH EXIT STATUS
The
.B ippserver
program returns 1 if it is unable to process the command-line arguments or register the IPP service.
Otherwise
.B ippserver
will run continuously until terminated.
.SH CONFORMING TO
The
.B ippserver
program is unique to CUPS and conforms to the IPP Everywhere (PWG 5100.14) specification.
.SH ENVIRONMENT
.B ippserver
adds environment variables starting with "IPP_" for all IPP Job attributes in the print request.
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.
.LP
Enumerated values are converted to their keyword equivalents.
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".
.SH EXAMPLES
Run
.B ippserver
with a service name of My Cool Printer:
.nf

    ippserver "My Cool Printer"
.fi
.LP
Run the
.BR file (1)
command whenever a job is sent to the server:
.nf

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