README.txt

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