README.txt

   1 README - CUPS v1.3rc2 - 2007-07-30
   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 was developed by Easy Software Products
  12     and is now owned and maintained by Apple Inc. to promote a
  13     standard printing solution for all UNIX vendors and users.  CUPS
  14     provides the System V and Berkeley 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     CUPS is licensed under the GNU General Public License and GNU
  33     Library General Public License versions 2.
  34
  35
  36 READING THE DOCUMENTATION
  37
  38     Once you have installed the software you can access the
  39     documentation (and a bunch of other stuff) on-line at:
  40
  41         http://localhost:631/
  42
  43     If you're having trouble getting that far, the documentation
  44     is located under the "doc/help" directory.
  45
  46     Please read the documentation before asking questions.
  47
  48
  49 GETTING SUPPORT AND OTHER RESOURCES
  50
  51     If you have problems, READ THE DOCUMENTATION FIRST!  We also
  52     provide many discussion forums which are available at:
  53
  54         http://www.cups.org/newsgroups.php
  55
  56     See the CUPS web site at "http://www.cups.org/" for other
  57     site links.
  58
  59
  60 SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER
  61
  62     CUPS 1.3 includes a web-based administration tool that allows
  63     you to manage printers, classes, and jobs on your server.
  64     Open the following URL in your browser to access the printer
  65     administration tools:
  66
  67         http://localhost:631/admin/
  68
  69     DO NOT use the hostname for your machine - it will not work
  70     with the default CUPS configuration.  To enable
  71     administration access on other addresses, check the "Allow
  72     Remote Administration" box and click on the "Change Settings"
  73     button.
  74
  75     You will be asked for the administration password (root or
  76     any other user in the sys/system/root group on your system)
  77     when performing any administrative function.
  78
  79
  80 SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
  81
  82     CUPS works best with PPD (PostScript Printer Description)
  83     files.  In a pinch you can also use System V style printer
  84     interface scripts.
  85
  86     CUPS includes several sample PPD files you can use:
  87
  88         Driver                         PPD File
  89         -----------------------------  ------------
  90         Dymo Label Printers            dymo.ppd
  91         Intellitech Intellibar         intelbar.ppd
  92         EPSON Stylus Color Series      stcolor.ppd
  93         EPSON Stylus Photo Series      stphoto.ppd
  94         EPSON Stylus New Color Series  stcolor2.ppd
  95         EPSON Stylus New Photo Series  stphoto2.ppd
  96         EPSON 9-pin Series             epson9.ppd
  97         EPSON 24-pin Series            epson24.ppd
  98         HP DeskJet Series              deskjet.ppd
  99         HP LaserJet Series             laserjet.ppd
 100         OKIDATA 9-Pin Series           okidata9.ppd
 101         OKIDATA 24-Pin Series          okidat24.ppd
 102         Zebra CPCL Label Printer       zebracpl.ppd
 103         Zebra EPL1 Label Printer       zebraep1.ppd
 104         Zebra EPL2 Label Printer       zebraep2.ppd
 105         Zebra ZPL Label Printer        zebra.ppd
 106
 107     Run the "lpinfo" command to list the available printers:
 108
 109         lpinfo -v
 110
 111     Then use the correct URI to add the printer using the
 112     "lpadmin" command:
 113
 114         lpadmin -p printername -E -v URI -m filename.ppd
 115
 116     Network printers typically use "socket" or "lpd" URIs:
 117
 118         lpadmin -p printername -E -v socket://11.22.33.44 -m filename.ppd
 119         lpadmin -p printername -E -v lpd://11.22.33.44/ -m filename.ppd
 120
 121     The sample drivers provide basic printing capabilities, but
 122     generally do not exercise the full potential of the printers
 123     or CUPS.
 124
 125
 126 PRINTING FILES
 127
 128     CUPS provides both the System V "lp" and Berkeley "lpr"
 129     commands for printing:
 130
 131         lp filename
 132         lpr filename
 133
 134     Both the "lp" and "lpr" commands support printing options for
 135     the driver:
 136
 137         lp -omedia=A4 -oresolution=600dpi filename
 138         lpr -omedia=A4 -oresolution=600dpi filename
 139
 140     CUPS recognizes many types of images files as well as PDF,
 141     PostScript, HP-GL/2, and text files, so you can print those
 142     files directly rather than through an application.
 143
 144     If you have an application that generates output specifically
 145     for your printer then you need to use the "-oraw" or "-l"
 146     options:
 147
 148         lp -oraw filename
 149         lpr -l filename
 150
 151     This will prevent the filters from misinterpreting your print
 152     file.
 153
 154
 155 LEGAL STUFF
 156
 157     CUPS is Copyright 2007 by Apple Inc.  CUPS, the CUPS logo, and
 158     the Common UNIX Printing System are the trademark property of
 159     Apple Inc.
 160
 161     The MD5 Digest code is Copyright 1999 Aladdin Enterprises.
 162
 163     The PDF filter (pdftops) is based on the Xpdf software,
 164     Copyright 1996-2005 by Derek B. Noonburg.
 165
 166     This software is based in part on the work of the Independent
 167     JPEG Group.
 168
 169     CUPS is provided under the terms of the GNU General Public
 170     License and GNU Library General Public License. This program
 171     is distributed in the hope that it will be useful, but
 172     WITHOUT ANY WARRANTY; without even the implied warranty of
 173     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 174     "doc/help/license.html" or "LICENSE.txt" files for more
 175     information.