man/cups.man

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