README.txt

   1 README - CUPS v1.3svn - 2007-01-03
   2 ----------------------------------
   3
   4 Looking for compile instructions?  Read the file "INSTALL.txt"
   5 instead...
   6
   7
   8 INTRODUCTION
   9
  10     CUPS provides a portable printing layer for UNIX(r)-based
  11     operating systems.  It has been developed by Easy Software
  12     Products to promote a standard printing solution for all UNIX
  13     vendors and users.  CUPS provides the System V and Berkeley
  14     command-line interfaces.
  15
  16     CUPS uses the Internet Printing Protocol ("IPP") as the basis
  17     for managing print jobs and queues.  The Line Printer Daemon
  18     ("LPD") Server Message Block ("SMB"), and AppSocket (a.k.a.
  19     JetDirect) protocols are also supported with reduced
  20     functionality.  CUPS adds network printer browsing and
  21     PostScript Printer Description ("PPD") based printing options
  22     to support real-world printing under UNIX.
  23
  24     CUPS includes an image file RIP that supports printing of
  25     image files to non-PostScript printers.  A customized version
  26     of GPL Ghostscript for CUPS called ESP Ghostscript is
  27     available separately to support printing of PostScript files
  28     within the CUPS driver framework.  Sample drivers for Dymo,
  29     EPSON, HP, OKIDATA, and Zebra printers are included that use
  30     these filters.
  31
  32     Drivers for thousands of printers are provided with our ESP
  33     Print Pro software, available at:
  34
  35             http://www.easysw.com/printpro/
  36
  37     CUPS is licensed under the GNU General Public License and GNU
  38     Library General Public License.  Please contact Easy Software
  39     Products for commercial support and "binary distribution"
  40     rights.
  41
  42
  43 READING THE DOCUMENTATION
  44
  45     Once you have installed the software you can access the
  46     documentation (and a bunch of other stuff) on-line at:
  47
  48         http://localhost:631/
  49
  50     If you're having trouble getting that far, the documentation
  51     is located 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
  59     provide many discussion forums which are available at:
  60
  61         http://www.cups.org/newsgroups.php
  62
  63     Commercial support (with a guaranteed response time) is
  64     available from Easy Software Products.  For more information
  65     see:
  66
  67         http://www.easysw.com/cups/
  68
  69     See the CUPS web site at "http://www.cups.org/" for other
  70     site links.
  71
  72
  73 SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER
  74
  75     CUPS 1.2 includes a web-based administration tool that allows
  76     you to manage printers, classes, and jobs on your server.
  77     Open the following URL in your browser to access the printer
  78     administration tools:
  79
  80         http://localhost:631/admin/
  81
  82     DO NOT use the hostname for your machine - it will not work
  83     with the default CUPS configuration.  To enable
  84     administration access on other addresses, check the "Allow
  85     Remote Administration" box and click on the "Change Settings"
  86     button.
  87
  88     You will be asked for the administration password (root or
  89     any other user in the sys/system/root group on your system)
  90     when performing any administrative function.
  91
  92
  93 SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
  94
  95     CUPS works best with PPD (PostScript Printer Description)
  96     files.  In a pinch you can also use System V style printer
  97     interface scripts.
  98
  99     CUPS includes several sample PPD files you can use:
 100
 101         Driver                         PPD File
 102         -----------------------------  ------------
 103         Dymo Label Printers            dymo.ppd
 104         EPSON Stylus Color Series      stcolor.ppd
 105         EPSON Stylus Photo Series      stphoto.ppd
 106         EPSON Stylus New Color Series  stcolor2.ppd
 107         EPSON Stylus New Photo Series  stphoto2.ppd
 108         EPSON 9-pin Series             epson9.ppd
 109         EPSON 24-pin Series            epson24.ppd
 110         HP DeskJet Series              deskjet.ppd
 111         HP New DeskJet Series          deskjet2.ppd
 112         HP LaserJet Series             laserjet.ppd
 113         OKIDATA 9-Pin Series           okidata9.ppd
 114         OKIDATA 24-Pin Series          okidat24.ppd
 115         Zebra CPCL Label Printer       zebracpl.ppd
 116         Zebra EPL1 Label Printer       zebraep1.ppd
 117         Zebra EPL2 Label Printer       zebraep2.ppd
 118         Zebra ZPL Label Printer        zebra.ppd
 119
 120     Run the "lpinfo" command to list the available printers:
 121
 122         lpinfo -v
 123
 124     Then use the correct URI to add the printer using the
 125     "lpadmin" command:
 126
 127         lpadmin -p printername -E -v URI -m filename.ppd
 128
 129     Network printers typically use "socket" or "lpd" URIs:
 130
 131         lpadmin -p printername -E -v socket://11.22.33.44 -m filename.ppd
 132         lpadmin -p printername -E -v lpd://11.22.33.44/ -m filename.ppd
 133
 134     The sample drivers provide basic printing capabilities, but
 135     generally do not exercise the full potential of the printers
 136     or CUPS.  For fully-functional commercial printer drivers
 137     check out our ESP Print Pro software at:
 138
 139         http://www.easysw.com/printpro/
 140
 141
 142 PRINTING FILES
 143
 144     CUPS provides both the System V "lp" and Berkeley "lpr"
 145     commands for printing:
 146
 147         lp filename
 148         lpr filename
 149
 150     Both the "lp" and "lpr" commands support printing options for
 151     the driver:
 152
 153         lp -omedia=A4 -oresolution=600dpi filename
 154         lpr -omedia=A4 -oresolution=600dpi filename
 155
 156     CUPS recognizes many types of images files as well as PDF,
 157     PostScript, HP-GL/2, and text files, so you can print those
 158     files directly rather than through an application.
 159
 160     If you have an application that generates output specifically
 161     for your printer then you need to use the "-oraw" or "-l"
 162     options:
 163
 164         lp -oraw filename
 165         lpr -l filename
 166
 167     This will prevent the filters from misinterpreting your print
 168     file.
 169
 170
 171 LEGAL STUFF
 172
 173     CUPS is Copyright 1993-2007 by Easy Software Products.  CUPS,
 174     the CUPS logo, and the Common UNIX Printing System are the
 175     trademark property of Easy Software Products.
 176
 177     The MD5 Digest code is Copyright 1999 Aladdin Enterprises.
 178
 179     The PDF filter (pdftops) is based on the Xpdf software,
 180     Copyright 1996-2005 by Derek B. Noonburg.
 181
 182     This software is based in part on the work of the Independent
 183     JPEG Group.
 184
 185     CUPS is provided under the terms of the GNU General Public
 186     License and GNU Library General Public License. This program
 187     is distributed in the hope that it will be useful, but
 188     WITHOUT ANY WARRANTY; without even the implied warranty of
 189     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 190     "doc/help/license.html" or "LICENSE.txt" files for more
 191     information.
 192
 193     For commercial licensing information, please contact:
 194
 195         Attn: CUPS Licensing Information
 196         Easy Software Products
 197         44141 Airport View Drive, Suite 204
 198         Hollywood, Maryland 20636 USA
 199
 200         Voice: +1.301.373.9600
 201         Email: cups-info@cups.org
 202         WWW: http://www.cups.org/
 203
 204     Note that commercial licensors may also require a license from
 205     Derek B. Noonburg who developed the Xpdf software used to print
 206     PDF files.