man/cups.man

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