X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fcups.git;a=blobdiff_plain;f=README.md;h=ee1125b34ea80cfdc05c5854d16c20c1d68d896a;hp=5879456253952f74429677f8d2aacf910fa337db;hb=e35d176c54420e940c32cff2fe8d638b89630dde;hpb=e944dbd40f3b25afb935b998adc01483c628ab17
diff --git a/README.md b/README.md
index 587945625..ee1125b34 100644
--- a/README.md
+++ b/README.md
@@ -1,13 +1,9 @@
-README - CUPS v2.3b1 - 2017-11-10
+README - CUPS v2.3.1 - 2019-10-07
=================================
-Looking for compile instructions? Read the file `INSTALL.md` instead...
-
-
INTRODUCTION
------------
-
CUPS is a standards-based, open source printing system developed by Apple Inc.
for macOS® and other UNIX®-like operating systems. CUPS uses the Internet
Printing Protocol ("IPP") and provides System V and Berkeley command-line
@@ -29,8 +25,21 @@ CUPS is licensed under the Apache License Version 2.0. See the file
READING THE DOCUMENTATION
-------------------------
+Initial documentation to get you started is provided in the root directory of
+the CUPS sources:
+
+- `CHANGES.md`: A list of changes in the current major release of CUPS.
+- `CONTRIBUTING.md`: Guidelines for contributing to the CUPS project.
+- `CREDITS.md`: A list of past contributors to the CUPS project.
+- `DEVELOPING.md`: Guidelines for developing code for the CUPS project.
+- `INSTALL.md`: Instructions for building and installing CUPS.
+- `LICENSE`: The CUPS license agreement (Apache 2.0).
+- `NOTICE`: Copyright notices and exceptions to the CUPS license agreement.
+- `README.md`: This file.
+
Once you have installed the software you can access the documentation (and a
-bunch of other stuff) online at .
+bunch of other stuff) online at and using the `man`
+command, for example `man cups`.
If you're having trouble getting that far, the documentation is located under
the `doc/help` and `man` directories.
@@ -56,11 +65,11 @@ in your browser to access the printer administration tools:
*Do not* use the hostname for your machine - it will not work with the default
CUPS configuration. To enable administration access on other addresses, check
-the `Allow Remote Administration` box and click on the `Change Settings button.
+the `Allow Remote Administration` box and click on the `Change Settings` button.
You will be asked for the administration password (root or any other user in the
-sys/system/root/admin/lpadmin group on your system) when performing any
-administrative function.
+"sys", "system", "root", "admin", or "lpadmin" group on your system) when
+performing any administrative function.
SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
@@ -70,28 +79,28 @@ CUPS currently uses PPD (PostScript Printer Description) files that describe
printer capabilities and driver programs needed for each printer. The
`everywhere` PPD is used for nearly all modern networks printers sold since
about 2009. For example, the following command creates a print queue for a
-printer at address 11.22.33.44:
+printer at address "11.22.33.44":
lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere
CUPS also includes several sample PPD files you can use for "legacy" printers:
- Driver PPD Name
- ----------------------------- ------------------------------
- Dymo Label Printers drv:///sample.drv/dymo.ppd
- Intellitech Intellibar drv:///sample.drv/intelbar.ppd
- EPSON 9-pin Series drv:///sample.drv/epson9.ppd
- EPSON 24-pin Series drv:///sample.drv/epson24.ppd
- Generic PCL Laser Printer drv:///sample.drv/generpcl.ppd
- Generic PostScript Printer drv:///sample.drv/generic.ppd
- HP DeskJet Series drv:///sample.drv/deskjet.ppd
- HP LaserJet Series drv:///sample.drv/laserjet.ppd
- OKIDATA 9-Pin Series drv:///sample.drv/okidata9.ppd
- OKIDATA 24-Pin Series drv:///sample.drv/okidat24.ppd
- Zebra CPCL Label Printer drv:///sample.drv/zebracpl.ppd
- Zebra EPL1 Label Printer drv:///sample.drv/zebraep1.ppd
- Zebra EPL2 Label Printer drv:///sample.drv/zebraep2.ppd
- Zebra ZPL Label Printer drv:///sample.drv/zebra.ppd
+ Driver | PPD Name
+ ----------------------------- | ------------------------------
+ Dymo Label Printers | drv:///sample.drv/dymo.ppd
+ Intellitech Intellibar | drv:///sample.drv/intelbar.ppd
+ EPSON 9-pin Series | drv:///sample.drv/epson9.ppd
+ EPSON 24-pin Series | drv:///sample.drv/epson24.ppd
+ Generic PCL Laser Printer | drv:///sample.drv/generpcl.ppd
+ Generic PostScript Printer | drv:///sample.drv/generic.ppd
+ HP DeskJet Series | drv:///sample.drv/deskjet.ppd
+ HP LaserJet Series | drv:///sample.drv/laserjet.ppd
+ OKIDATA 9-Pin Series | drv:///sample.drv/okidata9.ppd
+ OKIDATA 24-Pin Series | drv:///sample.drv/okidat24.ppd
+ Zebra CPCL Label Printer | drv:///sample.drv/zebracpl.ppd
+ Zebra EPL1 Label Printer | drv:///sample.drv/zebraep1.ppd
+ Zebra EPL2 Label Printer | drv:///sample.drv/zebraep2.ppd
+ Zebra ZPL Label Printer | drv:///sample.drv/zebra.ppd
You can run the `lpinfo -m` command to list all of the available drivers:
@@ -148,11 +157,12 @@ This will prevent the filters from misinterpreting your print file.
LEGAL STUFF
-----------
-Copyright © 2007-2017 by Apple Inc.
+Copyright © 2007-2019 by Apple Inc.
+Copyright © 1997-2007 by Easy Software Products.
-CUPS is provided under the terms of the Apache License, Version 2.0. A copy of
-this license can be found in the file `LICENSE`. Additional legal information
-is provided in the file `NOTICE`.
+CUPS is provided under the terms of the Apache License, Version 2.0 with
+exceptions for GPL2/LGPL2 software. A copy of this license can be found in the
+file `LICENSE`. Additional legal information is provided in the file `NOTICE`.
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR