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