[thirdparty/cups.git] / man / cups.1

.\"
.\" cups (intro) man page for CUPS.
.\"
.\" Copyright © 2007-2019 by Apple Inc.
.\" Copyright © 1997-2006 by Easy Software Products.
.\"
.\" Licensed under Apache License v2.0.  See the file "LICENSE" for more
.\" information.
.\"
.TH cups 1 "CUPS" "26 April 2019" "Apple Inc."
.SH NAME
cups \- a standards-based, open source printing system
.SH DESCRIPTION
.B CUPS
is the software you use to print from applications like word processors, email readers, photo editors, and web browsers. It converts the page descriptions produced by your application (put a paragraph here, draw a line there, and so forth) into something your printer can understand and then sends the information to the printer for printing.
.LP
Now, since every printer manufacturer does things differently, printing can be very complicated.
.B CUPS
does its best to hide this from you and your application so that you can concentrate on printing and less on how to print. Generally, the only time you need to know anything about your printer is when you use it for the first time, and even then
.B CUPS
can often figure things out on its own.
.SS HOW DOES IT WORK?
The first time you print to a printer,
.B CUPS
creates a queue to keep track of the current status of the printer (everything OK, out of paper, etc.) and any pages you have printed. Most of the time the queue points to a printer connected directly to your computer via a USB port, however it can also point to a printer on your network, a printer on the Internet, or multiple printers depending on the configuration. Regardless of where the queue points, it will look like any other printer to you and your applications.
.LP
Every time you print something,
.B CUPS
creates a job which contains the queue you are sending the print to, the name of the document you are printing, and the page descriptions. Job are numbered (queue-1, queue-2, and so forth) so you can monitor the job as it is printed or cancel it if you see a mistake. When
.B CUPS
gets a job for printing, it determines the best programs (filters, printer drivers, port monitors, and backends) to convert the pages into a printable format and then runs them to actually print the job.
.LP
When the print job is completely printed,
.B CUPS
removes the job from the queue and moves on to any other jobs you have submitted. You can also be notified when the job is finished, or if there are any errors during printing, in several different ways.
.SS WHERE DO I BEGIN?
The easiest way to start is by using the web interface to configure your printer. Go to "http://localhost:631" and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
.LP
When you are asked for a username and password, enter your login username and password or the "root" username and password.
.LP
After the printer is added you will be asked to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click/press on the Set Default Options button to save them. Some printers also support auto-configuration - click/press on the Query Printer for Default Options button to update the options automatically.
.LP
Once you have added the printer, you can print to it from any application. You can also choose Print Test Page from the maintenance menu to print a simple test page and verify that everything is working properly.
.LP
You can also use the
.BR lpadmin (8)
and
.BR lpinfo (8)
commands to add printers to
.BR CUPS .
Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
.SS HOW DO I GET HELP?
The
.B CUPS
web site (http://www.CUPS.org) provides access to the
.I cups
and
.I cups-devel
mailing lists, additional documentation and resources, and a bug report database. Most vendors also provide online discussion forums to ask printing questions for your operating system of choice.
.SH ENVIRONMENT
.B CUPS
commands use the following environment variables to override the default locations of files and so forth. For security reasons, these environment variables are ignored for setuid programs:
.TP 5
.B CUPS_ANYROOT
Whether to allow any X.509 certificate root (Y or N).
.TP 5
.B CUPS_CACHEDIR
The directory where semi-persistent cache files can be found.
.TP 5
.B CUPS_DATADIR
The directory where data files can be found.
.TP 5
.B CUPS_ENCRYPTION
The default level of encryption (Always, IfRequested, Never, Required).
.TP 5
.B CUPS_EXPIREDCERTS
Whether to allow expired X.509 certificates (Y or N).
.TP 5
.B CUPS_GSSSERVICENAME
The Kerberos service name used for authentication.
.TP 5
.B CUPS_SERVER
The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
.TP 5
.B CUPS_SERVERBIN
The directory where server helper programs, filters, backend, etc. can be found.
.TP 5
.B CUPS_SERVERROOT
The root directory of the server.
.TP 5
.B CUPS_STATEDIR
The directory where state files can be found.
.TP 5
.B CUPS_USER
Specifies the name of the user for print requests.
.TP 5
.B HOME
Specifies the home directory of the current user.
.TP 5
.B IPP_PORT
Specifies the default port number for IPP requests.
.TP 5
.B LOCALEDIR
Specifies the location of localization files.
.TP 5
.B LPDEST
Specifies the default print queue (System V standard).
.TP 5
.B PRINTER
Specifies the default print queue (Berkeley standard).
.TP 5
.B TMPDIR
Specifies the location of temporary files.
.SH FILES
.nf
.I ~/.cups/client.conf
.I ~/.cups/lpoptions
.fi
.SH CONFORMING TO
.B CUPS
conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
.SH NOTES
CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
Printers that do not support IPP can be supported using applications such as
.BR ippeveprinter (1).
.SH SEE ALSO
.BR cancel (1),
.BR client.conf (7),
.BR cupsctl (8),
.BR cupsd (8),
.BR lp (1),
.BR lpadmin (8),
.BR lpinfo (8),
.BR lpoptions (1),
.BR lpr (1),
.BR lprm (1),
.BR lpq (1),
.BR lpstat (1),
CUPS Online Help (http://localhost:631/help),
CUPS Web Site (http://www.CUPS.org),
PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
.SH COPYRIGHT
Copyright \[co] 2007-2019 by Apple Inc.
Commit	Line	Data
969af935	1	.\"
969af935 MS	2	.\" cups (intro) man page for CUPS.
969af935 MS	3	.\"
87030afb MS	4	.\" Copyright © 2007-2019 by Apple Inc.
87030afb MS	5	.\" Copyright © 1997-2006 by Easy Software Products.
969af935	6	.\"
87030afb MS	7	.\" Licensed under Apache License v2.0. See the file "LICENSE" for more
87030afb MS	8	.\" information.
969af935	9	.\"
87030afb	10	.TH cups 1 "CUPS" "26 April 2019" "Apple Inc."
969af935 MS	11	.SH NAME
	12	cups \- a standards-based, open source printing system
	13	.SH DESCRIPTION
	14	.B CUPS
	15	is the software you use to print from applications like word processors, email readers, photo editors, and web browsers. It converts the page descriptions produced by your application (put a paragraph here, draw a line there, and so forth) into something your printer can understand and then sends the information to the printer for printing.
	16	.LP
	17	Now, since every printer manufacturer does things differently, printing can be very complicated.
	18	.B CUPS
	19	does its best to hide this from you and your application so that you can concentrate on printing and less on how to print. Generally, the only time you need to know anything about your printer is when you use it for the first time, and even then
	20	.B CUPS
	21	can often figure things out on its own.
a99f5c6a	22	.SS HOW DOES IT WORK?
969af935 MS	23	The first time you print to a printer,
	24	.B CUPS
	25	creates a queue to keep track of the current status of the printer (everything OK, out of paper, etc.) and any pages you have printed. Most of the time the queue points to a printer connected directly to your computer via a USB port, however it can also point to a printer on your network, a printer on the Internet, or multiple printers depending on the configuration. Regardless of where the queue points, it will look like any other printer to you and your applications.
	26	.LP
	27	Every time you print something,
	28	.B CUPS
	29	creates a job which contains the queue you are sending the print to, the name of the document you are printing, and the page descriptions. Job are numbered (queue-1, queue-2, and so forth) so you can monitor the job as it is printed or cancel it if you see a mistake. When
	30	.B CUPS
	31	gets a job for printing, it determines the best programs (filters, printer drivers, port monitors, and backends) to convert the pages into a printable format and then runs them to actually print the job.
	32	.LP
	33	When the print job is completely printed,
	34	.B CUPS
	35	removes the job from the queue and moves on to any other jobs you have submitted. You can also be notified when the job is finished, or if there are any errors during printing, in several different ways.
a99f5c6a	36	.SS WHERE DO I BEGIN?
2909c66c	37	The easiest way to start is by using the web interface to configure your printer. Go to "http://localhost:631" and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
969af935 MS	38	.LP
	39	When you are asked for a username and password, enter your login username and password or the "root" username and password.
	40	.LP
2909c66c	41	After the printer is added you will be asked to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click/press on the Set Default Options button to save them. Some printers also support auto-configuration - click/press on the Query Printer for Default Options button to update the options automatically.
969af935 MS	42	.LP
	43	Once you have added the printer, you can print to it from any application. You can also choose Print Test Page from the maintenance menu to print a simple test page and verify that everything is working properly.
	44	.LP
	45	You can also use the
	46	.BR lpadmin (8)
	47	and
	48	.BR lpinfo (8)
	49	commands to add printers to
	50	.BR CUPS .
	51	Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
a99f5c6a MS	52	.SS HOW DO I GET HELP?
	53	The
	54	.B CUPS
	55	web site (http://www.CUPS.org) provides access to the
2909c66c MS	56	.I cups
	57	and
	58	.I cups-devel
	59	mailing lists, additional documentation and resources, and a bug report database. Most vendors also provide online discussion forums to ask printing questions for your operating system of choice.
969af935 MS	60	.SH ENVIRONMENT
	61	.B CUPS
	62	commands use the following environment variables to override the default locations of files and so forth. For security reasons, these environment variables are ignored for setuid programs:
	63	.TP 5
2909c66c	64	.B CUPS_ANYROOT
969af935 MS	65	Whether to allow any X.509 certificate root (Y or N).
969af935 MS	66	.TP 5
2909c66c	67	.B CUPS_CACHEDIR
969af935 MS	68	The directory where semi-persistent cache files can be found.
969af935 MS	69	.TP 5
2909c66c	70	.B CUPS_DATADIR
969af935 MS	71	The directory where data files can be found.
969af935 MS	72	.TP 5
2909c66c	73	.B CUPS_ENCRYPTION
969af935 MS	74	The default level of encryption (Always, IfRequested, Never, Required).
969af935 MS	75	.TP 5
2909c66c	76	.B CUPS_EXPIREDCERTS
969af935 MS	77	Whether to allow expired X.509 certificates (Y or N).
969af935 MS	78	.TP 5
2909c66c	79	.B CUPS_GSSSERVICENAME
969af935 MS	80	The Kerberos service name used for authentication.
969af935 MS	81	.TP 5
2909c66c MS	82	.B CUPS_SERVER
	83	The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
	84	.TP 5
	85	.B CUPS_SERVERBIN
969af935 MS	86	The directory where server helper programs, filters, backend, etc. can be found.
969af935 MS	87	.TP 5
2909c66c	88	.B CUPS_SERVERROOT
969af935 MS	89	The root directory of the server.
969af935 MS	90	.TP 5
2909c66c	91	.B CUPS_STATEDIR
969af935 MS	92	The directory where state files can be found.
969af935 MS	93	.TP 5
2909c66c	94	.B CUPS_USER
969af935 MS	95	Specifies the name of the user for print requests.
969af935 MS	96	.TP 5
2909c66c	97	.B HOME
969af935 MS	98	Specifies the home directory of the current user.
969af935 MS	99	.TP 5
2909c66c	100	.B IPP_PORT
969af935 MS	101	Specifies the default port number for IPP requests.
969af935 MS	102	.TP 5
2909c66c	103	.B LOCALEDIR
969af935 MS	104	Specifies the location of localization files.
969af935 MS	105	.TP 5
2909c66c	106	.B LPDEST
969af935 MS	107	Specifies the default print queue (System V standard).
969af935 MS	108	.TP 5
2909c66c	109	.B PRINTER
969af935 MS	110	Specifies the default print queue (Berkeley standard).
969af935 MS	111	.TP 5
2909c66c	112	.B TMPDIR
969af935 MS	113	Specifies the location of temporary files.
969af935 MS	114	.SH FILES
2909c66c MS	115	.nf
	116	.I ~/.cups/client.conf
	117	.I ~/.cups/lpoptions
	118	.fi
969af935 MS	119	.SH CONFORMING TO
	120	.B CUPS
	121	conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
87030afb MS	122	.SH NOTES
	123	CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
	124	Printers that do not support IPP can be supported using applications such as
	125	.BR ippeveprinter (1).
969af935	126	.SH SEE ALSO
2909c66c MS	127	.BR cancel (1),
	128	.BR client.conf (7),
	129	.BR cupsctl (8),
	130	.BR cupsd (8),
	131	.BR lp (1),
	132	.BR lpadmin (8),
	133	.BR lpinfo (8),
	134	.BR lpoptions (1),
	135	.BR lpr (1),
	136	.BR lprm (1),
	137	.BR lpq (1),
	138	.BR lpstat (1),
	139	CUPS Online Help (http://localhost:631/help),
	140	CUPS Web Site (http://www.CUPS.org),
	141	PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
969af935	142	.SH COPYRIGHT
87030afb	143	Copyright \[co] 2007-2019 by Apple Inc.