Print this page
Bump Apache dependency to Apache 2
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man4/mod_ipp.4
+++ new/usr/src/man/man4/mod_ipp.4
1 1 '\" te
2 2 .\" Copyright (c) 2003, Sun Microsystems, Inc.
3 3 .\" All Rights Reserved.
|
↓ open down ↓ |
3 lines elided |
↑ open up ↑ |
4 4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
5 5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
6 6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
7 7 .TH MOD_IPP 4 "Nov 26, 2003"
8 8 .SH NAME
9 9 mod_ipp \- Embedded Internet Print Protocol (IPP) listener for the Apache HTTP
10 10 server
11 11 .SH SYNOPSIS
12 12 .LP
13 13 .nf
14 -\fB/usr/apache/libexec/mod_ipp.so\fR
14 +\fB/usr/apache2/2.2/libexec/mod_ipp.so\fR
15 15 .fi
16 16
17 17 .SH DESCRIPTION
18 18 .sp
19 19 .LP
20 20 The \fBmod_ipp\fR module implements RFCs 2910 and 2911 to provide an IPP
21 21 handling service for the Apache HTTP server. When loaded on the Apache server,
22 22 \fBmod_ipp\fR processes all HTTP requests with MIME types of
23 23 \fBapplication/ipp\fR. The \fBmod_ipp\fR module also processes additional
24 24 configuration directives to enable or disable portions of the protocol support.
25 25 .SS "Using Configuration Directives"
26 26 .sp
27 27 .LP
28 28 The following is a list of configuration directives that apply to the Apache
29 29 IPP Listening service:
30 30 .RS +4
31 31 .TP
32 32 .ie t \(bu
33 33 .el o
34 34 ipp-conformance (\fIautomatic\fR|\fI1.0\fR|\fI1.1\fR)
35 35 .RE
36 36 .RS +4
37 37 .TP
38 38 .ie t \(bu
39 39 .el o
40 40 ipp-operation (\fIoperation\fR) (\fBenable\fR|\fBdisable\fR)
41 41 .RS +4
42 42 .TP
43 43 .ie t \(bu
44 44 .el o
45 45 \fBenable\fR|\fBdisable\fR
46 46 .sp
47 47 The values \fBtrue\fR, \fByes\fR, \fBon\fR, \fBenable\fR are considered to be
48 48 synonymous and will enable support for the named operation. All other values
49 49 will disable support for the named operation.
50 50 .RE
51 51 .RE
52 52 .SS "Operations"
53 53 .sp
54 54 .LP
55 55 The following is a list of IPP handling service operations:
56 56 .sp
57 57 .ne 2
58 58 .na
59 59 \fB\fBprint-job\fR\fR
60 60 .ad
61 61 .RS 26n
62 62 This operation is a required IPP operation that allows client systems to submit
63 63 a print job with a single document embedded in the data stream. This operation
64 64 is primarily used from the IPP support Microsoft has provided for its Windows
65 65 (9X/ME/NT/2K/XP).
66 66 .RE
67 67
68 68 .sp
69 69 .ne 2
70 70 .na
71 71 \fB\fBprint-uri\fR\fR
72 72 .ad
73 73 .RS 26n
74 74 This is an optional IPP operation that allows client systems to submit a print
75 75 job with a reference (URL) for a single document. This operation is currently
76 76 not supported by the \fBmod_ipp\fR Apache Module.
77 77 .RE
78 78
79 79 .sp
80 80 .ne 2
81 81 .na
82 82 \fB\fBvalidate-job\fR\fR
83 83 .ad
84 84 .RS 26n
85 85 This is a required IPP operation that allows client systems to simulate the
86 86 submission of a print job to verify that the server is capable of handling the
87 87 job. This operation is supported by \fBmod_ipp\fR.
88 88 .RE
89 89
90 90 .sp
91 91 .ne 2
92 92 .na
93 93 \fB\fBcreate-job\fR\fR
94 94 .ad
95 95 .RS 26n
96 96 This is an optional IPP operation that allows client systems to submit a print
97 97 job. The operation is used with the \fBsend-document\fR and \fBsend-uri\fR
98 98 operations.
99 99 .RE
100 100
101 101 .sp
102 102 .ne 2
103 103 .na
104 104 \fB\fBget-jobs\fR\fR
105 105 .ad
106 106 .RS 26n
107 107 This is a required IPP operation that allows client systems to retrieve a list
108 108 of print jobs from the print service.
109 109 .RE
110 110
111 111 .sp
112 112 .ne 2
113 113 .na
114 114 \fB\fBget-printer-attributes\fR\fR
115 115 .ad
116 116 .RS 26n
117 117 This is a required IPP operation that allows client systems to retrieve
118 118 attributes from the print service that describes the named printer object.
119 119 .RE
120 120
121 121 .sp
122 122 .ne 2
123 123 .na
124 124 \fB\fBpause-printer\fR\fR
125 125 .ad
126 126 .RS 26n
127 127 This an optional IPP operation that allows client systems to stop job
128 128 processing on the named print queue.
129 129 .RE
130 130
131 131 .sp
132 132 .ne 2
133 133 .na
134 134 \fB\fBresume-printer\fR\fR
135 135 .ad
136 136 .RS 26n
137 137 This is an optional IPP operation that allows client systems to resume job
138 138 processing on the named print queue.
139 139 .RE
140 140
141 141 .sp
142 142 .ne 2
143 143 .na
144 144 \fB\fBpurge-jobs\fR\fR
145 145 .ad
146 146 .RS 26n
147 147 This is an optional IPP operation that allows client systems to cancel all
148 148 print jobs on the named print queue.
149 149 .RE
150 150
151 151 .sp
152 152 .ne 2
153 153 .na
154 154 \fB\fBsend-document\fR\fR
155 155 .ad
156 156 .RS 26n
157 157 This is a required IPP operation that allows client systems to add documents to
158 158 print jobs created with the \fBcreate-job\fR operation, but not yet submitted.
159 159 .RE
160 160
161 161 .sp
162 162 .ne 2
163 163 .na
164 164 \fB\fBsend-uri\fR\fR
165 165 .ad
166 166 .RS 26n
167 167 This is an optional IPP operation that allows a client system to add a document
168 168 reference (URI) to a print job created with the \fBcreate-job\fR operation, but
169 169 not yet submitted. This operation is currently not supported by the
170 170 \fBmod_ipp\fR Apache Module.
171 171 .RE
172 172
173 173 .sp
174 174 .ne 2
175 175 .na
176 176 \fB\fBcancel-job\fR\fR
177 177 .ad
178 178 .RS 26n
179 179 This is a required IPP operation that allows client systems to cancel print
180 180 jobs.
181 181 .RE
182 182
183 183 .sp
184 184 .ne 2
185 185 .na
186 186 \fB\fBget-job-attributes\fR\fR
187 187 .ad
188 188 .RS 26n
189 189 This is a required IPP operation that allows client systems to retrieve
190 190 attributes that describe a print job from the print service.
191 191 .RE
192 192
193 193 .sp
194 194 .ne 2
195 195 .na
196 196 \fB\fBhold-job\fR\fR
197 197 .ad
198 198 .RS 26n
199 199 This is an optional IPP operation that allows client systems to hold print
200 200 jobs.
201 201 .RE
202 202
203 203 .sp
204 204 .ne 2
205 205 .na
206 206 \fB\fBrelease-job\fR\fR
207 207 .ad
208 208 .RS 26n
209 209 This is an optional IPP operation that allows client systems to release print
210 210 jobs.
211 211 .RE
212 212
213 213 .sp
214 214 .ne 2
215 215 .na
216 216 \fB\fBrestart-job\fR\fR
217 217 .ad
218 218 .RS 26n
219 219 This is an optional IPP operation that allows client systems to restart print
220 220 jobs.
221 221 .RE
222 222
223 223 .sp
224 224 .ne 2
225 225 .na
226 226 \fB\fBall\fR\fR
227 227 .ad
228 228 .RS 26n
229 229 This is a place holder for enabling or disabling support for all IPP operations
230 230 implemented by the \fBmod_ipp\fR Apache module.
231 231 .RE
232 232
233 233 .sp
234 234 .ne 2
235 235 .na
236 236 \fB\fBrequired\fR\fR
237 237 .ad
238 238 .RS 26n
239 239 This is a place holder for enabling or disabling support for the required IPP
240 240 operations implemented by the \fBmod_ipp\fR Apache module.
241 241 .RE
242 242
243 243 .SH EXAMPLES
244 244 .LP
|
↓ open down ↓ |
220 lines elided |
↑ open up ↑ |
245 245 \fBExample 1 \fRUsing a Configuration File to Start a Standalone Apache Server
246 246 .sp
247 247 .LP
248 248 The following configuration file can be used to start a standalone Apache
249 249 server to respond to IPP request sent to port 631.
250 250
251 251 .sp
252 252 .in +2
253 253 .nf
254 254 ServerType standalone
255 -ServerRoot "/usr/apache"
255 +ServerRoot "/usr/apache2/2.2"
256 256 PidFile /var/run/httpd-standalone-ipp.pid
257 257 ErrorLog /var/lp/logs/ipp-errors
258 258
259 259 Timeout 300
260 260 KeepAlive On
261 261 MaxKeepAliveRequests 100
262 262 KeepAliveTimeout 15
263 263
264 264 MinSpareServers 1
265 265 MaxSpareServers 3
266 266 StartServers 1
267 267 MaxClients 150
268 268 MaxRequestsPerChild 0
269 269
270 270 LoadModule ipp_module libexec/mod_ipp.so
271 271
272 272 ClearModuleList
273 273 AddModule mod_ipp.c
274 274 AddModule mod_so.c
275 275
276 276 Port 631
277 277
278 278 User lp
279 279 Group lp
280 280
281 281 ServerAdmin lp@localhost
282 282 DefaultType application/ipp
283 283
284 284 <IFModule mod_app>
285 285 <Location />
286 286 ipp-operation all on
287 287 </Location>
288 288 </IFModule mod_app>
289 289 .fi
290 290 .in -2
291 291
292 292 .sp
293 293 .LP
294 294 A more restrictive configuration might include the following parameters:
295 295
296 296 .sp
297 297 .in +2
298 298 .nf
299 299 <IFModule mod_app>
300 300 <Location />
301 301 ipp-operation all offn
302 302 ipp-operation required on
303 303 </Location>
304 304 </IFModule mod_app>
305 305 .fi
306 306 .in -2
307 307
308 308 .SH ATTRIBUTES
309 309 .sp
310 310 .LP
311 311 See \fBattributes\fR(5) or descriptions of the following attributes:
312 312 .sp
313 313
314 314 .sp
315 315 .TS
316 316 box;
317 317 c | c
318 318 l | l .
319 319 ATTRIBUTE TYPE ATTRIBUTE VALUE
320 320 _
321 321 Interface Stability External
322 322 .TE
323 323
324 324 .SH SEE ALSO
325 325 .sp
326 326 .LP
327 327 \fBman\fR(1), \fBcatman\fR(1M), \fBattributes\fR(5)
328 328 .sp
329 329 .LP
330 330 Herriot, R., Ed., Butler, S., Moore, P., Turner, R., Wenn, J. \fIRFC 2910,
331 331 Internet Printing Protocol/1.1: Encoding and Transport\fR. Network Working
332 332 Group. September 2000.
333 333 .sp
334 334 .LP
335 335 Hastings, T., Ed., Herriot, R., deBry, R., Isaacson, S., Powell, P. \fIRFC
336 336 2911, Internet Printing Protocol/1.1: Model and Semantics\fR. Network Working
337 337 Group. September 2000.
338 338 .sp
339 339 .LP
340 340 http://www.apache.org
341 341 .SH NOTES
342 342 .sp
343 343 .LP
344 344 Configuration file directives are processed in the order listed in the config
345 345 file. The default behavior is to enable support for all operations implemented
346 346 in the \fBmod_ipp\fR Apache module.
347 347 .sp
348 348 .LP
349 349 Since the Apache IPP listening service implements some capabilities that are
350 350 more of operator features, it may not be desirable to enable all IPP operations
351 351 without requiring user authentication on the Apache listening service.
352 352 .sp
353 353 .LP
354 354 The following is an example of a more reasonable configuration for Apache IPP
355 355 servers without user authentication enabled:
356 356 .sp
357 357 .in +2
358 358 .nf
359 359 ipp-operations all disabled
360 360 ipp-operations required enabled
361 361 .fi
362 362 .in -2
363 363
364 364 .sp
365 365 .LP
366 366 The printers and jobs available under this service can be accessed using URIs
367 367 of the following form:
368 368 .sp
369 369 .in +2
370 370 .nf
371 371 printer:
372 372 http://server[:port]/printers/{queue}
373 373 ipp://server[:port]/printers/{queue}
374 374 job:
375 375 http://server[:port]/printers/{queue}/{job-id}
376 376 ipp://server[:port]/printers/{queue}/{job-id}
377 377 .fi
378 378 .in -2
379 379
380 380 .sp
381 381 .LP
382 382 631 is the default IPP port and implied when the URI scheme is \fBipp\fR.
383 383 However, some client implementations do not recognize the \fBipp\fR URI scheme
|
↓ open down ↓ |
118 lines elided |
↑ open up ↑ |
384 384 and require \fBhttp://server:631/...\fR instead. For example, Microsoft's IPP
385 385 client implementation does not recognize the \fBipp\fR scheme.
386 386 .sp
387 387 .LP
388 388 In addition to the documentation and man pages included with Solaris, more
389 389 information is available at http://www.apache.org
390 390 .sp
391 391 .LP
392 392 The \fBhttpd\fR(8) man page and other Apache man pages are provided with the
393 393 programming modules. To view the Apache manual pages with the man command, add
394 -\fB/usr/apache/man\fR to the \fBMANPATH\fR environment variable. See
394 +\fB/usr/apache2/2.2/man\fR to the \fBMANPATH\fR environment variable. See
395 395 \fBman\fR(1) for more information. Running \fBcatman\fR(1M) on the Apache
396 396 manual pages is not supported.
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX