From 5f1456afb461360194e60a6cd5e7780553ffc331 Mon Sep 17 00:00:00 2001 From: msweet Date: Mon, 16 Jun 2014 15:33:00 +0000 Subject: [PATCH] Cleanup online help. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11930 a1ca3aef-8c08-0410-bb20-df032aa958be --- doc/Makefile | 3 +-- doc/help/overview.html | 9 ++----- doc/help/security.html | 48 +------------------------------------ doc/help/spec-browsing.html | 0 doc/help/spec-cmp.html | 2 +- doc/help/spec-design.html | 6 ++--- doc/help/spec-ipp.html | 8 +++++-- doc/help/spec-pdf.html | 11 +-------- doc/help/whatsnew.html | 20 ---------------- doc/index.html.in | 12 ++-------- templates/help-header.tmpl | 18 ++++---------- 11 files changed, 22 insertions(+), 115 deletions(-) delete mode 100644 doc/help/spec-browsing.html delete mode 100644 doc/help/whatsnew.html diff --git a/doc/Makefile b/doc/Makefile index 88cdef20e..14dc02603 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -123,8 +123,7 @@ HELPFILES = \ help/spec-ppd.html \ help/spec-raster.html \ help/spec-stp.html \ - help/translation.html \ - help/whatsnew.html + help/translation.html # diff --git a/doc/help/overview.html b/doc/help/overview.html index 4a4b173b2..f8466378b 100644 --- a/doc/help/overview.html +++ b/doc/help/overview.html @@ -47,14 +47,9 @@ different ways.

Where Do I Begin?

-

Click on the Administration tab at -the top of this page. Click on the Add Printer button and follow the -prompts.

+

Click on the Administration tab at the top of this page. Click on the Add Printer button and follow the prompts.

-
When you are asked for a username and password, enter your login -username and password or the "root" username and password. On MacOS X, the login -username (or "short name") is typically your first and last name in -lowercase.
+
When you are asked for a username and password, enter your login username and password or the "root" username and password. On OS X®, the login username (or "short name") is typically your first and last name in lowercase.

After the printer is added, CUPS will ask you to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as diff --git a/doc/help/security.html b/doc/help/security.html index 3bd564253..23455f4b4 100644 --- a/doc/help/security.html +++ b/doc/help/security.html @@ -38,18 +38,6 @@ authentication:

username and password information - this is the default on MacOS X and systems with GNU TLS or OpenSSL installed.

-
  • Digest authentication uses an MD5 checksum of the - username, password, and domain ("CUPS"), so the original - username and password is not sent over the network. - -

    The current implementation does not authenticate the - entire message and uses the client's IP address for the - nonce value, making it possible to launch "man in the - middle" and replay attacks from the same client.

    - -

    Recommendation: Enable encryption to hide the - username and password information.

  • -
  • Local certificate authentication passes 128-bit "certificates" that identify an authenticated user. Certificates are created on-the-fly from random data and @@ -101,20 +89,6 @@ variety of denial of service attacks:

    Recommendation: None.

  • -
  • Flooding the network with broadcast packets on port - 631. - -

    It might be possible to disable browsing if this - condition is detected by the CUPS software, however if - there are large numbers of printers available on the - network such an algorithm might think that an attack was - occurring when instead a valid update was being - received.

    - -

    Recommendation: Block browse packets from - foreign or untrusted networks using a router or - firewall.

  • -
  • Sending partial IPP requests; specifically, sending part of an attribute value and then stopping transmission. @@ -146,27 +120,7 @@ variety of denial of service attacks:

    Encryption Issues

    -

    CUPS supports 128-bit SSL 3.0 and TLS 1.0 encryption of -network connections via the OpenSSL, GNU TLS, and CDSA encryption -libraries. In additional to the potential security issues posed -by the SSL and TLS protocols, CUPS currently has the following -additional issue:

    - -
      - -
    1. Certification validation/revocation; currently CUPS - does not validate or revoke server or client certificates - when establishing a secure connection. This can - potentially lead to "man in the middle" and - impersonation/spoofing attacks over unsecured networks. - Future versions of CUPS will support both validation and - revocation of server certificates. - -

      Recommendation: Do not depend on encryption for - security when connecting to servers over the Internet or - untrusted WAN links.

    2. - -
    +

    CUPS supports 128-bit TLS encryption of network connections via the GNU TLS library, OS X Security framework, and Windows SSPI APIs. Secure deployment of TLS depends on proper certificate management and software maintenance.

    diff --git a/doc/help/spec-browsing.html b/doc/help/spec-browsing.html deleted file mode 100644 index e69de29bb..000000000 diff --git a/doc/help/spec-cmp.html b/doc/help/spec-cmp.html index 9b01233ce..4bbe7f0ee 100644 --- a/doc/help/spec-cmp.html +++ b/doc/help/spec-cmp.html @@ -215,7 +215,7 @@ rpmbuild -ta cups-version-source.tar.gz
     tools/testrpm
    -sudo rpm -U /usr/src/redhat/RPMS/i386/cups*.rpm
    +sudo rpm -U /usr/src/redhat/RPMS/{arm,i386,x64_64}/cups*.rpm
     
     sudo tools/testosx
     open cups.pkg
    diff --git a/doc/help/spec-design.html b/doc/help/spec-design.html
    index 28a14eb31..4b1311a9e 100644
    --- a/doc/help/spec-design.html
    +++ b/doc/help/spec-design.html
    @@ -31,7 +31,7 @@ WIDTH="768" HEIGHT="768" ALT="CUPS Block Diagram">
     
     

    Config Files

    -

    The scheduler uses several configuration files to store the server settings (cupsd.conf), available classes (classes.conf), available printers (printers.conf), current notification subscriptions (subscriptions.conf), and supported file types and filters (mime.types, mime.convs). In addition, PostScript Printer Description ("PPD") files or interface scripts are associated with each printer, and the scheduler has cache files for remote printers, PPD files, and current jobs to optimize the scheduler's startup speed and availability.

    +

    The scheduler uses several configuration files to store the server settings (cupsd.conf), available classes (classes.conf), available printers (printers.conf), current notification subscriptions (subscriptions.conf), and supported file types and filters (mime.types, mime.convs). In addition, PostScript Printer Description ("PPD") files or interface scripts are associated with each printer, and the scheduler has cache files for remote printers, PPD files, and current jobs to optimize the scheduler's startup speed and availability.

    Job Files

    @@ -41,8 +41,8 @@ WIDTH="768" HEIGHT="768" ALT="CUPS Block Diagram">

    Log Files

    -

    The scheduler keeps three kinds of log files which are normally stored in the /var/log/cups directory. The access_log file lists every HTTP and IPP request that is processed by the scheduler. The error_log file contains messages from the scheduler and its helper applications that can be used -to track down problems. The page_log file lists every page that is printed, allowing for simple print accounting.

    +

    The scheduler keeps three kinds of log files which are normally stored in the /var/log/cups directory. The access_log file lists every HTTP and IPP request that is processed by the scheduler. The error_log file contains messages from the scheduler and its helper applications that can be used +to track down problems. The page_log file lists every page that is printed, allowing for simple print accounting.

    Log files are rotated automatically by the scheduler when they reach the configured size limit, by default 1MB. If the limit is set to 0 then no rotation is performed in the scheduler - this mode is often used by Linux distributions so they can use the logrotated(8) program to rotate them instead.

    diff --git a/doc/help/spec-ipp.html b/doc/help/spec-ipp.html index 0a3228a6b..3a9fd6cfa 100644 --- a/doc/help/spec-ipp.html +++ b/doc/help/spec-ipp.html @@ -369,7 +369,8 @@ Print-Job request:
    The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute. -
    "job-billing" (text(MAX)):CUPS 1.1 +
    "job-billing" (text(MAX))CUPS 1.1 or + "job-account-id (text(MAX))"CUPS 1.7:
    The client OPTIONALLY supplies a billing string that is logged with the page accounting information. @@ -476,7 +477,8 @@ Create-Job request:
    The client OPTIONALLY supplies one or more authentication values as specified by the "auth-info-required" attribute. -
    "job-billing" (text(MAX)):CUPS 1.1 +
    "job-billing" (text(MAX))CUPS 1.1 or + "job-account-id (text(MAX))CUPS 1.7:
    The client OPTIONALLY supplies a billing string that is logged with the page accounting information. @@ -2169,6 +2171,8 @@ document (fit-to-page=false). The default value is false.

    The job-billing attribute provides a text value to associate with a job for billing purposes. +

    Note: This attribute has been superceded by the "job-account-id" attribute defined in PWG 5100.11: Job and Printer Extensions - Set 2.
    +

    job-cancel-after (integer(1:MAX))CUPS 2.0

    The job-cancel-after attribute provides the maximum number of seconds that are allowed for processing a job.

    diff --git a/doc/help/spec-pdf.html b/doc/help/spec-pdf.html index 407f47887..7276c908a 100644 --- a/doc/help/spec-pdf.html +++ b/doc/help/spec-pdf.html @@ -9,16 +9,7 @@

    CUPS PDF Format

    -

    CUPS PDF files (application/vnd.cups-pdf) are device-dependent -PDF/A files that contain a job ticket information. These files -are typically produced by the CUPS pdftopdf filter -which handles job ticket generation, imposition, page labeling, -scaling, and other formatting options requested by the user. CUPS -PDF files are intended for direct consumption by a PDF-capable -printer, PDF RIP, or the pdftops filter.

    - -

    More information will be posted here as the PDF workflow -filters are added to CUPS.

    +

    CUPS PDF files (application/vnd.cups-pdf) are device-dependent PDF files that contain a job ticket information.

    diff --git a/doc/help/whatsnew.html b/doc/help/whatsnew.html deleted file mode 100644 index 24e630e56..000000000 --- a/doc/help/whatsnew.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - What's New in CUPS 1.7 - - - - -

    What's New in CUPS 1.7

    - -

    This page provides a high-level outline of the changes in CUPS 1.7. If you have never used CUPS before, read the "Overview of CUPS" document instead.

    - -

    CUPS 1.7 is primarily a "polish" release. Users will appreciate improved support for paid, PIN, and release printing, as well as expanded support for printers conforming to the IPP Everywhere specification. Full support for this functionality depends on additional software from your operating system vendor.

    - -

    When supported by the printer or the remote server, CUPS now compresses print data sent over the network to greatly improve print speed and reduce bandwidth usage. This happens automatically when printing through IPP and is available as an option when using the ipptool utility.

    - -

    Developers can now enumerate supported sizes and option values, as well as query a printer to discovery which media is loaded, making it possible to easily build customized user interfaces without the use of printer drivers or PPD files.

    - - - diff --git a/doc/index.html.in b/doc/index.html.in index c15f8fef3..c94db2d9a 100644 --- a/doc/index.html.in +++ b/doc/index.html.in @@ -24,26 +24,21 @@

    CUPS @CUPS_VERSION@

    -

    CUPS is the standards-based, open source printing system developed by Apple Inc. for OS® X and other UNIX®-like operating systems.

    +

    CUPS is the standards-based, open source printing system developed by Apple Inc. for OS X® and other UNIX®-like operating systems.

    diff --git a/templates/help-header.tmpl b/templates/help-header.tmpl index b528f865e..86343e7ea 100644 --- a/templates/help-header.tmpl +++ b/templates/help-header.tmpl @@ -34,16 +34,8 @@ AUTOSAVE="org.cups.help" RESULTS="20">

    Online Help

    -

    This is the CUPS online help interface. Enter search words -above or click on any of the documentation links to display -online help information.

    - -

    If you are new to CUPS, read the "Overview of CUPS" page. Veteran users -should read the "What's New in CUPS -1.6" page.

    - -

    The CUPS home page also -provides many resources including user discussion forums, answers -to frequently-asked questions, and a form for submitting bug -reports and feature requests.

    } +

    This is the CUPS online help interface. Enter search words above or click on any of the documentation links to display online help information.

    + +

    If you are new to CUPS, read the "Overview of CUPS" page.

    + +

    The CUPS home page also provides many resources including user discussion forums, answers to frequently-asked questions, and a form for submitting bug reports and feature requests.

    } -- 2.39.2