README.txt

   1 README - CUPS v2.2.2 - 2017-01-17
   2 ---------------------------------
   3
   4 Looking for compile instructions?  Read the file "INSTALL.txt" instead...
   5
   6
   7 INTRODUCTION
   8
   9     CUPS is a standards-based, open source printing system developed by Apple
  10     Inc. for macOS® and other UNIX®-like operating systems.  CUPS uses the
  11     Internet Printing Protocol ("IPP") and provides System V and Berkeley
  12     command-line interfaces, a web interface, and a C API to manage printers and
  13     print jobs.  It supports printing to both local (parallel, serial, USB) and
  14     networked printers, and printers can be shared from one computer to another,
  15     even over the Internet!
  16
  17     Internally, CUPS uses PostScript Printer Description ("PPD") files to
  18     describe printer capabilities and features and a wide variety of generic
  19     and device-specific programs to convert and print many types of files.
  20     Sample drivers are included with CUPS to support many Dymo, EPSON, HP,
  21     Intellitech, OKIDATA, and Zebra printers.  Many more drivers are available
  22     online and (in some cases) on the driver CD-ROM that came with your printer.
  23
  24     CUPS is licensed under the GNU General Public License and GNU Library
  25     General Public License versions 2.  See the file "LICENSE.txt" for more
  26     information.
  27
  28
  29 READING THE DOCUMENTATION
  30
  31     Once you have installed the software you can access the documentation (and
  32     a bunch of other stuff) online at:
  33
  34         http://localhost:631/
  35
  36     If you're having trouble getting that far, the documentation is located
  37     under the "doc/help" directory.
  38
  39     Please read the documentation before asking questions.
  40
  41
  42 GETTING SUPPORT AND OTHER RESOURCES
  43
  44     If you have problems, READ THE DOCUMENTATION FIRST!  We also provide two
  45     mailing lists which are available at:
  46
  47         http://lists.cups.org/mailman/listinfo
  48
  49     See the CUPS web site at "http://www.cups.org/" for other resources.
  50
  51
  52 SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER
  53
  54     CUPS includes a web-based administration tool that allows you to manage
  55     printers, classes, and jobs on your server.  Open the following URL in your
  56     browser to access the printer administration tools:
  57
  58         http://localhost:631/admin/
  59
  60     DO NOT use the hostname for your machine - it will not work with the default
  61     CUPS configuration.  To enable administration access on other addresses,
  62     check the "Allow Remote Administration" box and click on the "Change
  63     Settings" button.
  64
  65     You will be asked for the administration password (root or any other user in
  66     the sys/system/root/admin/lpadmin group on your system) when performing any
  67     administrative function.
  68
  69
  70 SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
  71
  72     CUPS works best with PPD (PostScript Printer Description) files.  In a pinch
  73     you can also use System V style printer interface scripts.
  74
  75     CUPS includes several sample PPD files you can use:
  76
  77         Driver                         PPD Name
  78         -----------------------------  ------------------------------
  79         Dymo Label Printers            drv:///sample.drv/dymo.ppd
  80         Intellitech Intellibar         drv:///sample.drv/intelbar.ppd
  81         EPSON 9-pin Series             drv:///sample.drv/epson9.ppd
  82         EPSON 24-pin Series            drv:///sample.drv/epson24.ppd
  83         Generic PCL Laser Printer      drv:///sample.drv/generpcl.ppd
  84         Generic PostScript Printer     drv:///sample.drv/generic.ppd
  85         HP DeskJet Series              drv:///sample.drv/deskjet.ppd
  86         HP LaserJet Series             drv:///sample.drv/laserjet.ppd
  87         OKIDATA 9-Pin Series           drv:///sample.drv/okidata9.ppd
  88         OKIDATA 24-Pin Series          drv:///sample.drv/okidat24.ppd
  89         Zebra CPCL Label Printer       drv:///sample.drv/zebracpl.ppd
  90         Zebra EPL1 Label Printer       drv:///sample.drv/zebraep1.ppd
  91         Zebra EPL2 Label Printer       drv:///sample.drv/zebraep2.ppd
  92         Zebra ZPL Label Printer        drv:///sample.drv/zebra.ppd
  93
  94     Run the "lpinfo -m" command to list the available drivers:
  95
  96         lpinfo -m
  97
  98     Run the "lpinfo -v" command to list the available printers:
  99
 100         lpinfo -v
 101
 102     Then use the correct URI to add the printer using the "lpadmin" command:
 103
 104         lpadmin -p printername -E -v device-uri -m ppd-name
 105
 106     Network printers typically use "socket" or "lpd" URIs:
 107
 108         lpadmin -p printername -E -v socket://11.22.33.44 -m ppd-name
 109         lpadmin -p printername -E -v lpd://11.22.33.44/ -m ppd-name
 110
 111     The sample drivers provide basic printing capabilities, but generally do not
 112     exercise the full potential of the printers or CUPS.
 113
 114     CUPS also supports IPP Everywhere printers using the "everywhere" model,
 115     for example:
 116
 117         lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere
 118
 119
 120 PRINTING FILES
 121
 122     CUPS provides both the System V "lp" and Berkeley "lpr" commands for
 123     printing:
 124
 125         lp filename
 126         lpr filename
 127
 128     Both the "lp" and "lpr" commands support printing options for the driver:
 129
 130         lp -o media=A4 -o resolution=600dpi filename
 131         lpr -o media=A4 -o resolution=600dpi filename
 132
 133     CUPS recognizes many types of images files as well as PDF, PostScript,
 134     and text files, so you can print those files directly rather than through
 135     an application.
 136
 137     If you have an application that generates output specifically for your
 138     printer then you need to use the "-oraw" or "-l" options:
 139
 140         lp -o raw filename
 141         lpr -l filename
 142
 143     This will prevent the filters from misinterpreting your print file.
 144
 145
 146 LEGAL STUFF
 147
 148     CUPS is Copyright 2007-2017 by Apple Inc.  CUPS and the CUPS logo are
 149     trademarks of Apple Inc.
 150
 151     The MD5 Digest code is Copyright 1999 Aladdin Enterprises.
 152
 153     CUPS is provided under the terms of version 2 of the GNU General Public
 154     License and GNU Library General Public License. This program is distributed
 155     in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even
 156     the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 157     See the "doc/help/license.html" or "LICENSE.txt" files for more information.