[thirdparty/cups.git] / doc / help / man-cups.html

<!DOCTYPE HTML>
<html>
<!-- SECTION: Man Pages -->
<head>
	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	<title>cups(1)</title>
</head>
<body>
<h1 class="title">cups(1)</h1>
<h2 class="title"><a name="NAME">Name</a></h2>
cups - a standards-based, open source printing system
<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
<b>CUPS</b>
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.
<p>Now, since every printer manufacturer does things differently, printing can be very complicated.
<b>CUPS</b>
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</b>
can often figure things out on its own.
<h3><a name="HOW_DOES_IT_WORK_">How Does It Work?</a></h3>
The first time you print to a printer,
<b>CUPS</b>
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.
<p>Every time you print something,
<b>CUPS</b>
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</b>
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.
<p>When the print job is completely printed,
<b>CUPS</b>
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.
<h3><a name="WHERE_DO_I_BEGIN_">Where Do I Begin?</a></h3>
The easiest way to start is by using the web interface to configure your printer. Go to "<a href="http://localhost:631"">http://localhost:631"</a> and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
<p>When you are asked for a username and password, enter your login username and password or the "root" username and password.
<p>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.
<p>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.
<p>You can also use the
<b>lpadmin</b>(8)
and
<b>lpinfo</b>(8)
commands to add printers to
<b>CUPS</b>.
Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
<h3><a name="HOW_DO_I_GET_HELP_">How Do I Get Help?</a></h3>
The
<b>CUPS</b>
web site (<a href="http://www.CUPS.org">http://www.CUPS.org</a>) provides access to the
<i>cups</i>
and
<i>cups-devel</i>
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.
<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
<b>CUPS</b>
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:
<dl class="man">
<dt><b>CUPS_ANYROOT</b>
<dd style="margin-left: 5.0em">Whether to allow any X.509 certificate root (Y or N).
<dt><b>CUPS_CACHEDIR</b>
<dd style="margin-left: 5.0em">The directory where semi-persistent cache files can be found.
<dt><b>CUPS_DATADIR</b>
<dd style="margin-left: 5.0em">The directory where data files can be found.
<dt><b>CUPS_ENCRYPTION</b>
<dd style="margin-left: 5.0em">The default level of encryption (Always, IfRequested, Never, Required).
<dt><b>CUPS_EXPIREDCERTS</b>
<dd style="margin-left: 5.0em">Whether to allow expired X.509 certificates (Y or N).
<dt><b>CUPS_GSSSERVICENAME</b>
<dd style="margin-left: 5.0em">The Kerberos service name used for authentication.
<dt><b>CUPS_SERVER</b>
<dd style="margin-left: 5.0em">The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
<dt><b>CUPS_SERVERBIN</b>
<dd style="margin-left: 5.0em">The directory where server helper programs, filters, backend, etc. can be found.
<dt><b>CUPS_SERVERROOT</b>
<dd style="margin-left: 5.0em">The root directory of the server.
<dt><b>CUPS_STATEDIR</b>
<dd style="margin-left: 5.0em">The directory where state files can be found.
<dt><b>CUPS_USER</b>
<dd style="margin-left: 5.0em">Specifies the name of the user for print requests.
<dt><b>HOME</b>
<dd style="margin-left: 5.0em">Specifies the home directory of the current user.
<dt><b>IPP_PORT</b>
<dd style="margin-left: 5.0em">Specifies the default port number for IPP requests.
<dt><b>LOCALEDIR</b>
<dd style="margin-left: 5.0em">Specifies the location of localization files.
<dt><b>LPDEST</b>
<dd style="margin-left: 5.0em">Specifies the default print queue (System V standard).
<dt><b>PRINTER</b>
<dd style="margin-left: 5.0em">Specifies the default print queue (Berkeley standard).
<dt><b>TMPDIR</b>
<dd style="margin-left: 5.0em">Specifies the location of temporary files.
</dl>
<h2 class="title"><a name="FILES">Files</a></h2>
<pre class="man">
<i>~/.cups/client.conf</i>
<i>~/.cups/lpoptions</i>
</pre>
<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
<b>CUPS</b>
conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
<h2 class="title"><a name="NOTES">Notes</a></h2>
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
<b>ippeveprinter</b>(1).
<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
<b>cancel</b>(1),
<b>client.conf</b>(7),
<b>cupsctl</b>(8),
<b>cupsd</b>(8),
<b>lp</b>(1),
<b>lpadmin</b>(8),
<b>lpinfo</b>(8),
<b>lpoptions</b>(1),
<b>lpr</b>(1),
<b>lprm</b>(1),
<b>lpq</b>(1),
<b>lpstat</b>(1),
CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
CUPS Web Site (<a href="http://www.CUPS.org)">http://www.CUPS.org)</a>,
PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>)
<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
Copyright &copy; 2007-2019 by Apple Inc.

</body>
</html>
Commit	Line	Data
969af935 MS	1	<!DOCTYPE HTML>
	2	<html>
	3	<!-- SECTION: Man Pages -->
	4	<head>
	5	<link rel="stylesheet" type="text/css" href="../cups-printable.css">
	6	<title>cups(1)</title>
	7	</head>
	8	<body>
	9	<h1 class="title">cups(1)</h1>
	10	<h2 class="title"><a name="NAME">Name</a></h2>
	11	cups - a standards-based, open source printing system
	12	<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
	13	<b>CUPS</b>
	14	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.
	15	<p>Now, since every printer manufacturer does things differently, printing can be very complicated.
	16	<b>CUPS</b>
	17	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
	18	<b>CUPS</b>
	19	can often figure things out on its own.
a99f5c6a	20	<h3><a name="HOW_DOES_IT_WORK_">How Does It Work?</a></h3>
969af935 MS	21	The first time you print to a printer,
	22	<b>CUPS</b>
	23	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.
	24	<p>Every time you print something,
	25	<b>CUPS</b>
	26	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
	27	<b>CUPS</b>
	28	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.
	29	<p>When the print job is completely printed,
	30	<b>CUPS</b>
	31	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	32	<h3><a name="WHERE_DO_I_BEGIN_">Where Do I Begin?</a></h3>
2909c66c	33	The easiest way to start is by using the web interface to configure your printer. Go to "<a href="http://localhost:631"">http://localhost:631"</a> and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
969af935	34	<p>When you are asked for a username and password, enter your login username and password or the "root" username and password.
2909c66c	35	<p>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	36	<p>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.
969af935 MS	37	<p>You can also use the
87030afb	38	<b>lpadmin</b>(8)
969af935	39	and
87030afb	40	<b>lpinfo</b>(8)
969af935 MS	41	commands to add printers to
	42	<b>CUPS</b>.
	43	Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
a99f5c6a MS	44	<h3><a name="HOW_DO_I_GET_HELP_">How Do I Get Help?</a></h3>
	45	The
	46	<b>CUPS</b>
	47	web site (<a href="http://www.CUPS.org">http://www.CUPS.org</a>) provides access to the
2909c66c MS	48	<i>cups</i>
	49	and
	50	<i>cups-devel</i>
	51	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	52	<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
	53	<b>CUPS</b>
	54	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:
2909c66c MS	55	<dl class="man">
	56	<dt><b>CUPS_ANYROOT</b>
	57	<dd style="margin-left: 5.0em">Whether to allow any X.509 certificate root (Y or N).
	58	<dt><b>CUPS_CACHEDIR</b>
	59	<dd style="margin-left: 5.0em">The directory where semi-persistent cache files can be found.
	60	<dt><b>CUPS_DATADIR</b>
	61	<dd style="margin-left: 5.0em">The directory where data files can be found.
	62	<dt><b>CUPS_ENCRYPTION</b>
	63	<dd style="margin-left: 5.0em">The default level of encryption (Always, IfRequested, Never, Required).
2909c66c MS	64	<dt><b>CUPS_EXPIREDCERTS</b>
	65	<dd style="margin-left: 5.0em">Whether to allow expired X.509 certificates (Y or N).
	66	<dt><b>CUPS_GSSSERVICENAME</b>
	67	<dd style="margin-left: 5.0em">The Kerberos service name used for authentication.
	68	<dt><b>CUPS_SERVER</b>
	69	<dd style="margin-left: 5.0em">The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
	70	<dt><b>CUPS_SERVERBIN</b>
	71	<dd style="margin-left: 5.0em">The directory where server helper programs, filters, backend, etc. can be found.
	72	<dt><b>CUPS_SERVERROOT</b>
	73	<dd style="margin-left: 5.0em">The root directory of the server.
	74	<dt><b>CUPS_STATEDIR</b>
	75	<dd style="margin-left: 5.0em">The directory where state files can be found.
	76	<dt><b>CUPS_USER</b>
	77	<dd style="margin-left: 5.0em">Specifies the name of the user for print requests.
	78	<dt><b>HOME</b>
	79	<dd style="margin-left: 5.0em">Specifies the home directory of the current user.
	80	<dt><b>IPP_PORT</b>
	81	<dd style="margin-left: 5.0em">Specifies the default port number for IPP requests.
	82	<dt><b>LOCALEDIR</b>
	83	<dd style="margin-left: 5.0em">Specifies the location of localization files.
	84	<dt><b>LPDEST</b>
	85	<dd style="margin-left: 5.0em">Specifies the default print queue (System V standard).
	86	<dt><b>PRINTER</b>
	87	<dd style="margin-left: 5.0em">Specifies the default print queue (Berkeley standard).
	88	<dt><b>TMPDIR</b>
	89	<dd style="margin-left: 5.0em">Specifies the location of temporary files.
	90	</dl>
969af935	91	<h2 class="title"><a name="FILES">Files</a></h2>
2909c66c MS	92	<pre class="man">
	93	<i>~/.cups/client.conf</i>
	94	<i>~/.cups/lpoptions</i>
	95	</pre>
969af935 MS	96	<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
	97	<b>CUPS</b>
	98	conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
87030afb MS	99	<h2 class="title"><a name="NOTES">Notes</a></h2>
	100	CUPS printer drivers, backends, and PPD files are deprecated and will no longer be supported in a future feature release of CUPS.
	101	Printers that do not support IPP can be supported using applications such as
	102	<b>ippeveprinter</b>(1).
969af935	103	<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
87030afb MS	104	<b>cancel</b>(1),
	105	<b>client.conf</b>(7),
	106	<b>cupsctl</b>(8),
	107	<b>cupsd</b>(8),
	108	<b>lp</b>(1),
	109	<b>lpadmin</b>(8),
	110	<b>lpinfo</b>(8),
	111	<b>lpoptions</b>(1),
	112	<b>lpr</b>(1),
	113	<b>lprm</b>(1),
	114	<b>lpq</b>(1),
	115	<b>lpstat</b>(1),
2909c66c MS	116	CUPS Online Help (<a href="http://localhost:631/help)">http://localhost:631/help)</a>,
	117	CUPS Web Site (<a href="http://www.CUPS.org)">http://www.CUPS.org)</a>,
	118	PWG Internet Printing Protocol Workgroup (<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>)
969af935	119	<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
87030afb	120	Copyright © 2007-2019 by Apple Inc.
969af935 MS	121
	122	</body>
	123	</html>