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

.\"
.\" "$Id$"
.\"
.\" ippinfra man page for CUPS.
.\"
.\" Copyright 2014 by Apple Inc.
.\"
.\" These coded instructions, statements, and computer programs are the
.\" property of Apple Inc. and are protected by Federal copyright
.\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
.\" which should have been included with this file.  If this file is
.\" file is missing or damaged, see the license at "http://www.cups.org/".
.\"
.TH ippinfra 1 "CUPS" "16 September 2014" "Apple Inc."
.SH NAME
ippinfra \- a simple ipp infrastructure server
.SH SYNOPSIS
.B ippinfra
[
.B \-d
.I spool-directory
] [
.B \-h
] [
.B \-k
] [
.B \-n
.I hostname
] [
.B \-p
.I port
] [
.B \-u
.I username:password
] [
.B \-v[vvv]
]
.I service-name
.SH DESCRIPTION
.B ippinfra
is a simple Internet Printing Protocol (IPP) infrastructure server conforming to the IPP Shared Infrastructure Extensions (INFRA) specification. It can be used as a very basic infrastructure server between standard IPP clients and IPP proxies conforming to the INFRA specification.
.SH OPTIONS
The following options are recognized by
.B ippinfra:
.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
.B \-h
Shows program help.
.TP 5
.B \-k
Keeps the print documents in the spool directory rather than deleting them.
.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\-u \fIusername:password\fR
Specifies the username and password for the IPP proxy.
The default is "test:test123".
.TP 5
.B \-v[vvv]
Be (very) verbose when logging activity to the standard output.
.SH EXIT STATUS
The
.B ippinfra
program returns 1 if it is unable to process the command-line arguments.
Otherwise
.B ippinfra
will run continuously until terminated.
.SH CONFORMING TO
The
.B ippinfra
program is unique to CUPS and conforms to the IPP Shared Infrastructure Extensions (INFRA) specification as an Infrastructure Printer.
.SH EXAMPLES
Run
.B ippinfra
with a service name of My Cool Printer:
.nf

    ippinfra "My Cool Printer"
.fi
.LP
Specify a proxy username of "foo" and password of "bar":
.nf

    ippinfra \-u foo:bar "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.
.\"
.\" End of "$Id$".
.\"
Commit	Line	Data
d3331249 MS	1	.\"
	2	.\" "$Id$"
	3	.\"
	4	.\" ippinfra 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 ippinfra 1 "CUPS" "16 September 2014" "Apple Inc."
	15	.SH NAME
	16	ippinfra \- a simple ipp infrastructure server
	17	.SH SYNOPSIS
	18	.B ippinfra
	19	[
	20	.B \-d
	21	.I spool-directory
	22	] [
	23	.B \-h
	24	] [
	25	.B \-k
	26	] [
	27	.B \-n
	28	.I hostname
	29	] [
	30	.B \-p
	31	.I port
	32	] [
	33	.B \-u
	34	.I username:password
	35	] [
	36	.B \-v[vvv]
	37	]
	38	.I service-name
	39	.SH DESCRIPTION
	40	.B ippinfra
	41	is a simple Internet Printing Protocol (IPP) infrastructure server conforming to the IPP Shared Infrastructure Extensions (INFRA) specification. It can be used as a very basic infrastructure server between standard IPP clients and IPP proxies conforming to the INFRA specification.
	42	.SH OPTIONS
	43	The following options are recognized by
	44	.B ippinfra:
	45	.TP 5
	46	\fB\-d \fIspool-directory\fR
	47	Specifies the directory that will hold the print files.
	48	The default is a directory under the user's current temporary directory.
	49	.TP 5
	50	.B \-h
	51	Shows program help.
	52	.TP 5
	53	.B \-k
	54	Keeps the print documents in the spool directory rather than deleting them.
	55	.TP 5
	56	\fB\-n \fIhostname\fR
	57	Specifies the hostname that is reported by the server.
	58	The default is the name returned by the
	59	.BR hostname (1)
	60	command.
	61	.TP 5
	62	\fB\-p \fIport\fR
	63	Specifies the port number to listen on.
	64	The default is a user-specific number from 8000 to 8999.
65	.TP 5
66	\fB\-u \fIusername:password\fR
67	Specifies the username and password for the IPP proxy.
68	The default is "test:test123".
69	.TP 5
70	.B \-v[vvv]
71	Be (very) verbose when logging activity to the standard output.
72	.SH EXIT STATUS
73	The
74	.B ippinfra
75	program returns 1 if it is unable to process the command-line arguments.
76	Otherwise
77	.B ippinfra
78	will run continuously until terminated.
79	.SH CONFORMING TO
80	The
81	.B ippinfra
82	program is unique to CUPS and conforms to the IPP Shared Infrastructure Extensions (INFRA) specification as an Infrastructure Printer.
83	.SH EXAMPLES
84	Run
85	.B ippinfra
86	with a service name of My Cool Printer:
87	.nf
88
89	ippinfra "My Cool Printer"
90	.fi
91	.LP
92	Specify a proxy username of "foo" and password of "bar":
93	.nf
94
95	ippinfra \-u foo:bar "My Cool Printer"
96	.fi
97	.SH SEE ALSO
98	PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
99	.SH COPYRIGHT
100	Copyright \[co] 2007-2014 by Apple Inc.
101	.\"
102	.\" End of "$Id$".
103	.\"