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

.\"
.\" cups (intro) man page for CUPS.
.\"
.\" Copyright 2007-2014 by Apple Inc.
.\" Copyright 1997-2006 by Easy Software Products.
.\"
.\" 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 cups 1 "CUPS" "16 April 2014" "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 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-2015 by Apple Inc.
Commit	Line	Data
969af935	1	.\"
969af935 MS	2	.\" cups (intro) man page for CUPS.
	3	.\"
	4	.\" Copyright 2007-2014 by Apple Inc.
	5	.\" Copyright 1997-2006 by Easy Software Products.
	6	.\"
	7	.\" These coded instructions, statements, and computer programs are the
	8	.\" property of Apple Inc. and are protected by Federal copyright
	9	.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
	10	.\" which should have been included with this file. If this file is
	11	.\" file is missing or damaged, see the license at "http://www.cups.org/".
	12	.\"
f9988e18	13	.TH cups 1 "CUPS" "16 April 2014" "Apple Inc."
969af935 MS	14	.SH NAME
	15	cups \- a standards-based, open source printing system
	16	.SH DESCRIPTION
	17	.B CUPS
	18	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.
	19	.LP
	20	Now, since every printer manufacturer does things differently, printing can be very complicated.
	21	.B CUPS
	22	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
	23	.B CUPS
	24	can often figure things out on its own.
a99f5c6a	25	.SS HOW DOES IT WORK?
969af935 MS	26	The first time you print to a printer,
	27	.B CUPS
	28	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.
	29	.LP
	30	Every time you print something,
	31	.B CUPS
	32	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
	33	.B CUPS
	34	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.
	35	.LP
	36	When the print job is completely printed,
	37	.B CUPS
	38	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	39	.SS WHERE DO I BEGIN?
2909c66c	40	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	41	.LP
	42	When you are asked for a username and password, enter your login username and password or the "root" username and password.
	43	.LP
2909c66c	44	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	45	.LP
	46	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.
	47	.LP
	48	You can also use the
	49	.BR lpadmin (8)
	50	and
	51	.BR lpinfo (8)
	52	commands to add printers to
	53	.BR CUPS .
	54	Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
a99f5c6a MS	55	.SS HOW DO I GET HELP?
	56	The
	57	.B CUPS
	58	web site (http://www.CUPS.org) provides access to the
2909c66c MS	59	.I cups
	60	and
	61	.I cups-devel
	62	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	63	.SH ENVIRONMENT
	64	.B CUPS
	65	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:
	66	.TP 5
2909c66c	67	.B CUPS_ANYROOT
969af935 MS	68	Whether to allow any X.509 certificate root (Y or N).
969af935 MS	69	.TP 5
2909c66c	70	.B CUPS_CACHEDIR
969af935 MS	71	The directory where semi-persistent cache files can be found.
969af935 MS	72	.TP 5
2909c66c	73	.B CUPS_DATADIR
969af935 MS	74	The directory where data files can be found.
969af935 MS	75	.TP 5
2909c66c	76	.B CUPS_ENCRYPTION
969af935 MS	77	The default level of encryption (Always, IfRequested, Never, Required).
969af935 MS	78	.TP 5
2909c66c	79	.B CUPS_EXPIREDCERTS
969af935 MS	80	Whether to allow expired X.509 certificates (Y or N).
969af935 MS	81	.TP 5
2909c66c	82	.B CUPS_GSSSERVICENAME
969af935 MS	83	The Kerberos service name used for authentication.
969af935 MS	84	.TP 5
2909c66c MS	85	.B CUPS_SERVER
	86	The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
	87	.TP 5
	88	.B CUPS_SERVERBIN
969af935 MS	89	The directory where server helper programs, filters, backend, etc. can be found.
969af935 MS	90	.TP 5
2909c66c	91	.B CUPS_SERVERROOT
969af935 MS	92	The root directory of the server.
969af935 MS	93	.TP 5
2909c66c	94	.B CUPS_STATEDIR
969af935 MS	95	The directory where state files can be found.
969af935 MS	96	.TP 5
2909c66c	97	.B CUPS_USER
969af935 MS	98	Specifies the name of the user for print requests.
969af935 MS	99	.TP 5
2909c66c	100	.B HOME
969af935 MS	101	Specifies the home directory of the current user.
969af935 MS	102	.TP 5
2909c66c	103	.B IPP_PORT
969af935 MS	104	Specifies the default port number for IPP requests.
969af935 MS	105	.TP 5
2909c66c	106	.B LOCALEDIR
969af935 MS	107	Specifies the location of localization files.
969af935 MS	108	.TP 5
2909c66c	109	.B LPDEST
969af935 MS	110	Specifies the default print queue (System V standard).
969af935 MS	111	.TP 5
2909c66c	112	.B PRINTER
969af935 MS	113	Specifies the default print queue (Berkeley standard).
969af935 MS	114	.TP 5
2909c66c	115	.B TMPDIR
969af935 MS	116	Specifies the location of temporary files.
969af935 MS	117	.SH FILES
2909c66c MS	118	.nf
	119	.I ~/.cups/client.conf
	120	.I ~/.cups/lpoptions
	121	.fi
969af935 MS	122	.SH CONFORMING TO
	123	.B CUPS
	124	conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
	125	.SH SEE ALSO
2909c66c MS	126	.BR cancel (1),
	127	.BR client.conf (7),
	128	.BR cupsctl (8),
	129	.BR cupsd (8),
	130	.BR lp (1),
	131	.BR lpadmin (8),
	132	.BR lpinfo (8),
	133	.BR lpoptions (1),
	134	.BR lpr (1),
	135	.BR lprm (1),
	136	.BR lpq (1),
	137	.BR lpstat (1),
	138	CUPS Online Help (http://localhost:631/help),
	139	CUPS Web Site (http://www.CUPS.org),
	140	PWG Internet Printing Protocol Workgroup (http://www.pwg.org/ipp)
969af935	141	.SH COPYRIGHT
fbfee7a8	142	Copyright \[co] 2007-2015 by Apple Inc.