]> git.ipfire.org Git - thirdparty/cups.git/blobdiff - README.md
SIGSEGV in CUPS web ui when adding a printer
[thirdparty/cups.git] / README.md
index e1a3f829dcb85915783a8dd240c089b3431648a0..59c09c6998c54b61887fbe971dd8c1db86928a30 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
-README - CUPS v2.2.4 - 2017-04-18
+README - CUPS v2.3.0 - 2019-05-24
 =================================
 
-Looking for compile instructions?  Read the file "INSTALL.md" instead...
+Looking for compile instructions?  Read the file `INSTALL.md` instead...
 
 
 INTRODUCTION
@@ -22,20 +22,18 @@ included with CUPS to support many Dymo, EPSON, HP, Intellitech, OKIDATA, and
 Zebra printers.  Many more drivers are available online and (in some cases) on
 the driver CD-ROM that came with your printer.
 
-CUPS is licensed under the GNU General Public License and GNU Library General
-Public License versions 2.  See the file "LICENSE.txt" for more information.
+CUPS is licensed under the Apache License Version 2.0.  See the file
+"LICENSE" for more information.
 
 
 READING THE DOCUMENTATION
 -------------------------
 
 Once you have installed the software you can access the documentation (and a
-bunch of other stuff) online at:
-
-    http://localhost:631/
+bunch of other stuff) online at <http://localhost:631/>.
 
 If you're having trouble getting that far, the documentation is located under
-the "doc/help" directory.
+the `doc/help` and `man` directories.
 
 Please read the documentation before asking questions.
 
@@ -43,10 +41,8 @@ Please read the documentation before asking questions.
 GETTING SUPPORT AND OTHER RESOURCES
 -----------------------------------
 
-If you have problems, READ THE DOCUMENTATION FIRST!  We also provide two mailing
-lists which are available at:
-
-    https://lists.cups.org/mailman/listinfo
+If you have problems, *read the documentation first!*  We also provide two
+mailing lists which are available at <https://lists.cups.org/mailman/listinfo>.
 
 See the CUPS web site at <https://www.cups.org/> for other resources.
 
@@ -55,14 +51,12 @@ SETTING UP PRINTER QUEUES USING YOUR WEB BROWSER
 ------------------------------------------------
 
 CUPS includes a web-based administration tool that allows you to manage
-printers, classes, and jobs on your server.  Open the following URL in your
-browser to access the printer administration tools:
-
-    http://localhost:631/admin/
+printers, classes, and jobs on your server.  Open <http://localhost:631/admin/>
+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
@@ -72,10 +66,15 @@ administrative function.
 SETTING UP PRINTER QUEUES FROM THE COMMAND-LINE
 -----------------------------------------------
 
-CUPS works best with PPD (PostScript Printer Description) files.  In a pinch you
-can also use System V style printer interface scripts.
+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:
 
-CUPS includes several sample PPD files you can use:
+    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
     -----------------------------  ------------------------------
@@ -94,41 +93,42 @@ CUPS includes several sample PPD files you can use:
     Zebra EPL2 Label Printer       drv:///sample.drv/zebraep2.ppd
     Zebra ZPL Label Printer        drv:///sample.drv/zebra.ppd
 
-Run the "lpinfo -m" command to list the available drivers:
+You can run the `lpinfo -m` command to list all of the available drivers:
 
     lpinfo -m
 
-Run the "lpinfo -v" command to list the available printers:
+Run the `lpinfo -v` command to list the available printers:
 
     lpinfo -v
 
-Then use the correct URI to add the printer using the "lpadmin" command:
+Then use the correct URI to add the printer using the `lpadmin` command:
 
     lpadmin -p printername -E -v device-uri -m ppd-name
 
-Network printers typically use "socket" or "lpd" URIs:
+Current network printers typically use `ipp` or `ipps` URIS:
+
+    lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere
+    lpadmin -p printername -E -v ipps://11.22.33.44/ipp/print -m everywhere
+
+Older network printers typically use `socket` or `lpd` URIs:
 
     lpadmin -p printername -E -v socket://11.22.33.44 -m ppd-name
     lpadmin -p printername -E -v lpd://11.22.33.44/ -m ppd-name
 
 The sample drivers provide basic printing capabilities, but generally do not
-exercise the full potential of the printers or CUPS.
-
-CUPS also supports IPP Everywhere printers using the "everywhere" model, for
-example:
-
-    lpadmin -p printername -E -v ipp://11.22.33.44/ipp/print -m everywhere
+exercise the full potential of the printers or CUPS.  Other drivers provide
+greater printing capabilities.
 
 
 PRINTING FILES
 --------------
 
-CUPS provides both the System V "lp" and Berkeley "lpr" commands for printing:
+CUPS provides both the System V `lp` and Berkeley `lpr` commands for printing:
 
     lp filename
     lpr filename
 
-Both the "lp" and "lpr" commands support printing options for the driver:
+Both the `lp` and `lpr` commands support printing options for the driver:
 
     lp -o media=A4 -o resolution=600dpi filename
     lpr -o media=A4 -o resolution=600dpi filename
@@ -137,7 +137,7 @@ CUPS recognizes many types of images files as well as PDF, PostScript, and text
 files, so you can print those files directly rather than through an application.
 
 If you have an application that generates output specifically for your printer
-then you need to use the "-oraw" or "-l" options:
+then you need to use the `-oraw` or `-l` options:
 
     lp -o raw filename
     lpr -l filename
@@ -148,13 +148,14 @@ This will prevent the filters from misinterpreting your print file.
 LEGAL STUFF
 -----------
 
-CUPS is copyright © 2007-2017 by Apple Inc.  CUPS and the CUPS logo are
-trademarks of Apple Inc.
+Copyright © 2007-2019 by Apple Inc.
+Copyright © 1997-2007 by Easy Software Products.
 
-The MD5 Digest code is Copyright 1999 Aladdin Enterprises.
+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 version 2 of the GNU General Public License
-and GNU Library General Public License. This program is distributed in the hope
-that it will be useful, but WITHOUT ANY WARRANTY; without even the implied
-warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-"doc/help/license.html" or "LICENSE.txt" files for more information.
+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
+CONDITIONS OF ANY KIND, either express or implied.  See the License for the
+specific language governing permissions and limitations under the License.