README.md

   1 README - CUPS v2.3b8 - 2019-04-18
   2 =================================
   3
   4 > **Note:** CUPS v2.3b8 is not production code.  Do not use on production
   5 > systems.  For a production version of CUPS, please see the CUPS 2.2.x
   6 > releases.  **Do not use CUPS v2.3b8 on production systems.**
   7
   8
   9 Looking for compile instructions?  Read the file `INSTALL.md` instead...
  10
  11
  12 INTRODUCTION
  13 ------------
  14
  15
  16 CUPS is a standards-based, open source printing system developed by Apple Inc.
  17 for macOS® and other UNIX®-like operating systems.  CUPS uses the Internet
  18 Printing Protocol ("IPP") and provides System V and Berkeley command-line
  19 interfaces, a web interface, and a C API to manage printers and print jobs.  It
  20 supports printing to both local (parallel, serial, USB) and networked printers,
  21 and printers can be shared from one computer to another, even over the Internet!
  22
  23 Internally, CUPS uses PostScript Printer Description ("PPD") files to describe
  24 printer capabilities and features and a wide variety of generic and device-
  25 specific programs to convert and print many types of files.  Sample drivers are
  26 included with CUPS to support many Dymo, EPSON, HP, Intellitech, OKIDATA, and
  27 Zebra printers.  Many more drivers are available online and (in some cases) on
  28 the driver CD-ROM that came with your printer.
  29
  30 CUPS is licensed under the Apache License Version 2.0.  See the file
  31 "LICENSE" for more information.
  32
  33
  34 READING THE DOCUMENTATION
  35 -------------------------
  36
  37 Once you have installed the software you can access the documentation (and a
  38 bunch of other stuff) online at <http://localhost:631/>.
  39
  40 If you're having trouble getting that far, the documentation is located under
  41 the `doc/help` and `man` directories.
  42
  43 Please read the documentation before asking questions.
  44
  45
  46 GETTING SUPPORT AND OTHER RESOURCES
  47 -----------------------------------
  48
  49 If you have problems, *read the documentation first!*  We also provide two
  50 mailing lists which are available at <https://lists.cups.org/mailman/listinfo>.
  51
  52 See the CUPS web site at <https://www.cups.org/> for other resources.
  53
  54
  55 SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER
  56 ------------------------------------------------
  57
  58 CUPS includes a web-based administration tool that allows you to manage
  59 printers, classes, and jobs on your server.  Open <http://localhost:631/admin/>
  60 in your browser to access the printer administration tools:
  61
  62 *Do not* use the hostname for your machine - it will not work with the default
  63 CUPS configuration.  To enable administration access on other addresses, check
  64 the `Allow Remote Administration` box and click on the `Change Settings button.
  65
  66 You will be asked for the administration password (root or any other user in the
  67 sys/system/root/admin/lpadmin group on your system) when performing any
  68 administrative function.
  69
  70
  71 SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
  72 -----------------------------------------------
  73
  74 CUPS currently uses PPD (PostScript Printer Description) files that describe
  75 printer capabilities and driver programs needed for each printer.  The
  76 `everywhere` PPD is used for nearly all modern networks printers sold since
  77 about 2009.  For example, the following command creates a print queue for a
  78 printer at address 11.22.33.44:
  79
  80     lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere
  81
  82 CUPS also includes several sample PPD files you can use for "legacy" printers:
  83
  84     Driver                         PPD Name
  85     -----------------------------  ------------------------------
  86     Dymo Label Printers            drv:///sample.drv/dymo.ppd
  87     Intellitech Intellibar         drv:///sample.drv/intelbar.ppd
  88     EPSON 9-pin Series             drv:///sample.drv/epson9.ppd
  89     EPSON 24-pin Series            drv:///sample.drv/epson24.ppd
  90     Generic PCL Laser Printer      drv:///sample.drv/generpcl.ppd
  91     Generic PostScript Printer     drv:///sample.drv/generic.ppd
  92     HP DeskJet Series              drv:///sample.drv/deskjet.ppd
  93     HP LaserJet Series             drv:///sample.drv/laserjet.ppd
  94     OKIDATA 9-Pin Series           drv:///sample.drv/okidata9.ppd
  95     OKIDATA 24-Pin Series          drv:///sample.drv/okidat24.ppd
  96     Zebra CPCL Label Printer       drv:///sample.drv/zebracpl.ppd
  97     Zebra EPL1 Label Printer       drv:///sample.drv/zebraep1.ppd
  98     Zebra EPL2 Label Printer       drv:///sample.drv/zebraep2.ppd
  99     Zebra ZPL Label Printer        drv:///sample.drv/zebra.ppd
 100
 101 You can run the `lpinfo -m` command to list all of the available drivers:
 102
 103     lpinfo -m
 104
 105 Run the `lpinfo -v` command to list the available printers:
 106
 107     lpinfo -v
 108
 109 Then use the correct URI to add the printer using the `lpadmin` command:
 110
 111     lpadmin -p printername -E -v device-uri -m ppd-name
 112
 113 Current network printers typically use `ipp` or `ipps` URIS:
 114
 115     lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere
 116     lpadmin -p printername -E -v ipps://11.22.33.44/ipp/print -m everywhere
 117
 118 Older network printers typically use `socket` or `lpd` URIs:
 119
 120     lpadmin -p printername -E -v socket://11.22.33.44 -m ppd-name
 121     lpadmin -p printername -E -v lpd://11.22.33.44/ -m ppd-name
 122
 123 The sample drivers provide basic printing capabilities, but generally do not
 124 exercise the full potential of the printers or CUPS.  Other drivers provide
 125 greater printing capabilities.
 126
 127
 128 PRINTING FILES
 129 --------------
 130
 131 CUPS provides both the System V `lp` and Berkeley `lpr` commands for printing:
 132
 133     lp filename
 134     lpr filename
 135
 136 Both the `lp` and `lpr` commands support printing options for the driver:
 137
 138     lp -o media=A4 -o resolution=600dpi filename
 139     lpr -o media=A4 -o resolution=600dpi filename
 140
 141 CUPS recognizes many types of images files as well as PDF, PostScript, and text
 142 files, so you can print those files directly rather than through an application.
 143
 144 If you have an application that generates output specifically for your printer
 145 then you need to use the `-oraw` or `-l` options:
 146
 147     lp -o raw filename
 148     lpr -l filename
 149
 150 This will prevent the filters from misinterpreting your print file.
 151
 152
 153 LEGAL STUFF
 154 -----------
 155
 156 Copyright © 2007-2018 by Apple Inc.
 157 Copyright © 1997-2007 by Easy Software Products.
 158
 159 CUPS is provided under the terms of the Apache License, Version 2.0.  A copy of
 160 this license can be found in the file `LICENSE`.  Additional legal information
 161 is provided in the file `NOTICE`.
 162
 163 Unless required by applicable law or agreed to in writing, software distributed
 164 under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
 165 CONDITIONS OF ANY KIND, either express or implied.  See the License for the
 166 specific language governing permissions and limitations under the License.