README.txt

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