]> git.ipfire.org Git - thirdparty/cups.git/commitdiff
Add cups(1) man page with CUPS overview information and relevant links.
authormsweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be>
Fri, 28 Mar 2014 15:55:05 +0000 (15:55 +0000)
committermsweet <msweet@a1ca3aef-8c08-0410-bb20-df032aa958be>
Fri, 28 Mar 2014 15:55:05 +0000 (15:55 +0000)
Fix link embedding for man pages.

git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11773 a1ca3aef-8c08-0410-bb20-df032aa958be

CHANGES-1.7.txt
doc/Makefile
doc/help/man-cups.html [new file with mode: 0644]
doc/help/man-cupsaddsmb.html
doc/help/man-cupsfilter.html
doc/help/man-filter.html
doc/help/man-ippfind.html
man/Makefile
man/cups.man [new file with mode: 0644]
man/filter.man
man/mantohtml.c

index 14d69d665ea78a135b1db4cf3862b28c88909a61..49544805ad9d07311ab86001a95a4fa1e8407e33 100644 (file)
@@ -8,6 +8,8 @@ CHANGES IN CUPS V1.7.2
        - Documentation fixes (STR #3259, STR #4346, STR #4355)
        - Fixed the Japanese localization (STR #4385)
        - Added a German localization (STR #4363)
+       - The cupsfilter command incorrectly read the cupsd.conf file; it now
+         reads the cups-files.conf file instead.
        - Fixed OS X builds with Xcode 5.x (<rdar://problem/15914959>)
        - Fixed SSL support on Windows (STR #4358)
        - Fixed documentation and naming of Create-Job/Printer-Subscriptions
index c59d12e964f7a814edaaf30fba380f8653d52091..8e64da64a16ae84fbd897dd381cb16cfed20e42b 100644 (file)
@@ -1,16 +1,16 @@
 #
 # "$Id$"
 #
-#   Documentation makefile for CUPS.
+# Documentation makefile for CUPS.
 #
-#   Copyright 2007-2012 by Apple Inc.
-#   Copyright 1997-2007 by Easy Software Products.
+# Copyright 2007-2014 by Apple Inc.
+# Copyright 1997-2007 by Easy Software Products.
 #
-#   These coded instructions, statements, and computer programs are the
-#   property of Apple Inc. and are protected by Federal copyright
-#   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
-#   which should have been included with this file.  If this file is
-#   file is missing or damaged, see the license at "http://www.cups.org/".
+# These coded instructions, statements, and computer programs are the
+# property of Apple Inc. and are protected by Federal copyright
+# law.  Distribution and use rights are outlined in the file "LICENSE.txt"
+# which should have been included with this file.  If this file is
+# file is missing or damaged, see the license at "http://www.cups.org/".
 #
 
 include ../Makedefs
@@ -62,12 +62,13 @@ HELPFILES   =       \
                        help/glossary.html \
                        help/kerberos.html \
                        help/license.html \
-                       help/man-cupsaccept.html \
                        help/man-backend.html \
                        help/man-cancel.html \
+                       help/man-cups.html \
                        help/man-cups-config.html \
                        help/man-cups-lpd.html \
                        help/man-cups-snmp.html \
+                       help/man-cupsaccept.html \
                        help/man-cupsaddsmb.html \
                        help/man-cupsd.html \
                        help/man-cupsenable.html \
diff --git a/doc/help/man-cups.html b/doc/help/man-cups.html
new file mode 100644 (file)
index 0000000..2a692f1
--- /dev/null
@@ -0,0 +1,119 @@
+<!DOCTYPE HTML>
+<html>
+<!-- SECTION: Man Pages -->
+<head>
+       <link rel="stylesheet" type="text/css" href="../cups-printable.css">
+       <title>cups(1)</title>
+</head>
+<body>
+<h1 class="title">cups(1)</h1>
+<h2 class="title"><a name="NAME">Name</a></h2>
+cups - a standards-based, open source printing system
+<h2 class="title"><a name="DESCRIPTION">Description</a></h2>
+<b>CUPS</b>
+is the software you use to print from applications like word processors, email readers, photo editors, and web browsers. It converts the page descriptions produced by your application (put a paragraph here, draw a line there, and so forth) into something your printer can understand and then sends the information to the printer for printing.
+<p>Now, since every printer manufacturer does things differently, printing can be very complicated.
+<b>CUPS</b>
+does its best to hide this from you and your application so that you can concentrate on printing and less on how to print. Generally, the only time you need to know anything about your printer is when you use it for the first time, and even then
+<b>CUPS</b>
+can often figure things out on its own.
+<h2 class="title"><a name="HOW_DOES_IT_WORK_">How Does It Work?</a></h2>
+The first time you print to a printer,
+<b>CUPS</b>
+creates a queue to keep track of the current status of the printer (everything OK, out of paper, etc.) and any pages you have printed. Most of the time the queue points to a printer connected directly to your computer via a USB port, however it can also point to a printer on your network, a printer on the Internet, or multiple printers depending on the configuration. Regardless of where the queue points, it will look like any other printer to you and your applications.
+<p>Every time you print something,
+<b>CUPS</b>
+creates a job which contains the queue you are sending the print to, the name of the document you are printing, and the page descriptions. Job are numbered (queue-1, queue-2, and so forth) so you can monitor the job as it is printed or cancel it if you see a mistake. When
+<b>CUPS</b>
+gets a job for printing, it determines the best programs (filters, printer drivers, port monitors, and backends) to convert the pages into a printable format and then runs them to actually print the job.
+<p>When the print job is completely printed,
+<b>CUPS</b>
+removes the job from the queue and moves on to any other jobs you have submitted. You can also be notified when the job is finished, or if there are any errors during printing, in several different ways.
+<h2 class="title"><a name="WHERE_DO_I_BEGIN_">Where Do I Begin?</a></h2>
+The easiest way to start is by using the
+<b>CUPS</b>
+web interface to configure your printer. Go to "<a href="http://localhost:631"">http://localhost:631"</a> and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
+<p>When you are asked for a username and password, enter your login username and password or the "root" username and password.
+<p>After the printer is added,
+<b>CUPS</b>
+will ask you to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click on the Set Default Options button to save them. Some printers also support auto-configuration - click on the Query Printer for Default Options button to update the options automatically.
+<p>Once you have added the printer, you can print to it from any application. You can also choose Print Test Page from the maintenance menu to print a simple test page and verify that everything is working properly.
+<p>You can also use the
+<a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8)</a>
+and
+<a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8)</a>
+commands to add printers to
+<b>CUPS</b>.
+Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
+<h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
+<b>CUPS</b>
+commands use the following environment variables to override the default locations of files and so forth. For security reasons, these environment variables are ignored for setuid programs:
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVER
+<br>
+The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_ANYROOT
+<br>
+Whether to allow any X.509 certificate root (Y or N).
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_CACHEDIR
+<br>
+The directory where semi-persistent cache files can be found.
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_DATADIR
+<br>
+The directory where data files can be found.
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_ENCRYPTION
+<br>
+The default level of encryption (Always, IfRequested, Never, Required).
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_EXPIREDROOT
+<br>
+Whether to allow expired X.509 certificate roots (Y or N).
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_EXPIREDCERTS
+<br>
+Whether to allow expired X.509 certificates (Y or N).
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_GSSSERVICENAME
+<br>
+The Kerberos service name used for authentication.
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERBIN
+<br>
+The directory where server helper programs, filters, backend, etc. can be found.
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_SERVERROOT
+<br>
+The root directory of the server.
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_STATEDIR
+<br>
+The directory where state files can be found.
+<p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_USER
+<br>
+Specifies the name of the user for print requests.
+<p style="margin-left: 5.0em; text-indent: -5.0em">HOME
+<br>
+Specifies the home directory of the current user.
+<p style="margin-left: 5.0em; text-indent: -5.0em">IPP_PORT
+<br>
+Specifies the default port number for IPP requests.
+<p style="margin-left: 5.0em; text-indent: -5.0em">LOCALEDIR
+<br>
+Specifies the location of localization files.
+<p style="margin-left: 5.0em; text-indent: -5.0em">LPDEST
+<br>
+Specifies the default print queue (System V standard).
+<p style="margin-left: 5.0em; text-indent: -5.0em">PRINTER
+<br>
+Specifies the default print queue (Berkeley standard).
+<p style="margin-left: 5.0em; text-indent: -5.0em">TMPDIR
+<br>
+Specifies the location of temporary files.
+<h2 class="title"><a name="FILES">Files</a></h2>
+~/.cups/client.conf, ~/.cups/lpoptions
+<h2 class="title"><a name="CONFORMING_TO">Conforming To</a></h2>
+<b>CUPS</b>
+conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
+<h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
+<a href="man-cancel.html?TOPIC=Man+Pages"><b>cancel</b>(1),</a> <a href="man-client.conf.html?TOPIC=Man+Pages"><b>client.conf</b>(7),</a> <a href="man-cupsctl.html?TOPIC=Man+Pages"><b>cupsctl</b>(8),</a> <a href="man-cupsd.html?TOPIC=Man+Pages"><b>cupsd</b>(8),</a> <a href="man-lp.html?TOPIC=Man+Pages"><b>lp</b>(1),</a> <a href="man-lpadmin.html?TOPIC=Man+Pages"><b>lpadmin</b>(8),</a> <a href="man-lpinfo.html?TOPIC=Man+Pages"><b>lpinfo</b>(8),</a> <a href="man-lpoptions.html?TOPIC=Man+Pages"><b>lpoptions</b>(1),</a> <a href="man-lpr.html?TOPIC=Man+Pages"><b>lpr</b>(1),</a> <a href="man-lprm.html?TOPIC=Man+Pages"><b>lprm</b>(1),</a> <a href="man-lpq.html?TOPIC=Man+Pages"><b>lpq</b>(1),</a> <a href="man-lpstat.html?TOPIC=Man+Pages"><b>lpstat</b>(1),</a>
+<a href="http://localhost:631/help">http://localhost:631/help</a>,
+<a href="http://www.CUPS.org">http://www.CUPS.org</a>,
+<a href="http://www.pwg.org/ipp">http://www.pwg.org/ipp</a>
+<h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
+Copyright &copy; 2007-2014 by Apple Inc.
+
+</body>
+</html>
index 6586b6be51b20e02b3805a41ec04c0fc57deec19..abe6439e075d6c7c910ddbeb9b28da643c711dc9 100644 (file)
@@ -130,7 +130,7 @@ you use the lowercase filenames shown above, otherwise
 <h2 class="title"><a name="ADOBE_POSTSCRIPT_DRIVERS_FOR_WINDOWS_95__98__AND_ME">Adobe Postscript Drivers For Windows 95, 98, And Me</a></h2>
 <i>cupsaddsmb</i> can use the Adobe PostScript printer driver for
 Windows 95, 98, and ME, which are available for download from the
-Adobe web site (<a href="http://www.adobe.com).">http://www.adobe.com).</a>
+Adobe web site (<a href="http://www.adobe.com)">http://www.adobe.com)</a>.
 <p>The Adobe driver does not support the page-label, job-billing, or
 job-hold-until options.
 <p>Once you have installed the driver on a Windows system, copy the
index 84d816923f40e00e33f58c70fac9146ac7551134..62daa981d8688fe3bc8c9c4e139e6a8d20fdb7f3 100644 (file)
@@ -86,7 +86,7 @@ Delete the PPD file after conversion.
 returns a non-zero exit status on any error.
 <h2 class="title"><a name="ENVIRONMENT">Environment</a></h2>
 All of the standard
-<b>cups</b>(1)
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1)</a>
 environment variables affect the operation of
 <b>cupsfilter</b>.
 <h2 class="title"><a name="FILES">Files</a></h2>
@@ -101,7 +101,7 @@ The following command will generate a PDF preview of job 42 for a printer named
     cupsfilter -m application/pdf -d myprinter -j 42 >preview.pdf
 </pre>
 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
-<b>cups</b>(1), <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> <b>filter(7),</b> mime.convs<b>(7),</b> mime.types<b>(7),</b>
+<a href="man-cups.html?TOPIC=Man+Pages"><b>cups</b>(1),</a> <a href="man-cupsd.conf.html?TOPIC=Man+Pages"><b>cupsd.conf</b>(5),</a> <b>filter(7),</b> mime.convs<b>(7),</b> mime.types<b>(7),</b>
 <a href="http://localhost:631/help">http://localhost:631/help</a>
 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
 Copyright &copy; 2007-2014 by Apple Inc.
index 5e2166b67257b3ca1a70f5ea61afa067f70bbe88..4827d5ecb5665965579ac2b77381a20df50ddb49 100644 (file)
@@ -149,7 +149,7 @@ application/postscript).
 <p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_CACHEDIR
 <br>
 <br>
-The directory for semi-persistent cache files can be found.
+The directory where semi-persistent cache files can be found.
 <p style="margin-left: 5.0em; text-indent: -5.0em">CUPS_DATADIR
 <br>
 <br>
index ee1adbfa98241a41df9508626ec17295f5512a1c..ebe9518c8f556d02c9c48cd0f735de805a86b62e 100644 (file)
@@ -196,7 +196,7 @@ DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
 URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
 <p style="margin-left: 5.0em; text-indent: -5.0em">{service_uri}
 <br>
-URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./", etc.">http://printer.local./", etc.</a> etc.
+URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
 <p style="margin-left: 5.0em; text-indent: -5.0em">{txt_<i>key</i>}
 <br>
 Value of TXT record <i>key</i> (lowercase).
@@ -223,7 +223,7 @@ DNS-SD registration type, e.g., "_ipp._tcp", "_http._tcp", etc.
 URI scheme for DNS-SD registration type, e.g., "ipp", "http", etc.
 <p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_SERVICE_URI
 <br>
-URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./", etc.">http://printer.local./", etc.</a> etc.
+URI for service, e.g., "ipp://printer.local./ipp/print", "<a href="http://printer.local./"">http://printer.local./"</a>, etc.
 <p style="margin-left: 5.0em; text-indent: -5.0em">IPPFIND_TXT_<i>KEY</i>
 <br>
 Values of TXT record <i>KEY</i> (uppercase).
index 38e309f87d9f25f6f6ec5fcccf9944158770febe..c239951d260cf370cd32137c68f49f591412678c 100644 (file)
@@ -21,6 +21,7 @@ include ../Makedefs
 #
 
 MAN1   =       cancel.$(MAN1EXT) \
+               cups.$(MAN1EXT) \
                cups-config.$(MAN1EXT) \
                cupstestdsc.$(MAN1EXT) \
                cupstestppd.$(MAN1EXT) \
diff --git a/man/cups.man b/man/cups.man
new file mode 100644 (file)
index 0000000..8eeaa89
--- /dev/null
@@ -0,0 +1,132 @@
+.\"
+.\" "$Id$"
+.\"
+.\" cups (intro) man page for CUPS.
+.\"
+.\" Copyright 2007-2014 by Apple Inc.
+.\" Copyright 1997-2006 by Easy Software Products.
+.\"
+.\" These coded instructions, statements, and computer programs are the
+.\" property of Apple Inc. and are protected by Federal copyright
+.\" law.  Distribution and use rights are outlined in the file "LICENSE.txt"
+.\" which should have been included with this file.  If this file is
+.\" file is missing or damaged, see the license at "http://www.cups.org/".
+.\"
+.TH cups 1 "CUPS" "4 March 2014" "Apple Inc."
+.SH NAME
+cups \- a standards-based, open source printing system
+.SH DESCRIPTION
+.B CUPS
+is the software you use to print from applications like word processors, email readers, photo editors, and web browsers. It converts the page descriptions produced by your application (put a paragraph here, draw a line there, and so forth) into something your printer can understand and then sends the information to the printer for printing.
+.LP
+Now, since every printer manufacturer does things differently, printing can be very complicated.
+.B CUPS
+does its best to hide this from you and your application so that you can concentrate on printing and less on how to print. Generally, the only time you need to know anything about your printer is when you use it for the first time, and even then
+.B CUPS
+can often figure things out on its own.
+.SH HOW DOES IT WORK?
+The first time you print to a printer,
+.B CUPS
+creates a queue to keep track of the current status of the printer (everything OK, out of paper, etc.) and any pages you have printed. Most of the time the queue points to a printer connected directly to your computer via a USB port, however it can also point to a printer on your network, a printer on the Internet, or multiple printers depending on the configuration. Regardless of where the queue points, it will look like any other printer to you and your applications.
+.LP
+Every time you print something,
+.B CUPS
+creates a job which contains the queue you are sending the print to, the name of the document you are printing, and the page descriptions. Job are numbered (queue-1, queue-2, and so forth) so you can monitor the job as it is printed or cancel it if you see a mistake. When
+.B CUPS
+gets a job for printing, it determines the best programs (filters, printer drivers, port monitors, and backends) to convert the pages into a printable format and then runs them to actually print the job.
+.LP
+When the print job is completely printed,
+.B CUPS
+removes the job from the queue and moves on to any other jobs you have submitted. You can also be notified when the job is finished, or if there are any errors during printing, in several different ways.
+.SH WHERE DO I BEGIN?
+The easiest way to start is by using the
+.B CUPS
+web interface to configure your printer. Go to "http://localhost:631" and choose the Administration tab at the top of the page. Click/press on the Add Printer button and follow the prompts.
+.LP
+When you are asked for a username and password, enter your login username and password or the "root" username and password.
+.LP
+After the printer is added,
+.B CUPS
+will ask you to set the default printer options (paper size, output mode, etc.) for the printer. Make any changes as needed and then click on the Set Default Options button to save them. Some printers also support auto-configuration - click on the Query Printer for Default Options button to update the options automatically.
+.LP
+Once you have added the printer, you can print to it from any application. You can also choose Print Test Page from the maintenance menu to print a simple test page and verify that everything is working properly.
+.LP
+You can also use the
+.BR lpadmin (8)
+and
+.BR lpinfo (8)
+commands to add printers to
+.BR CUPS .
+Additionally, your operating system may include graphical user interfaces or automatically create printer queues when you connect a printer to your computer.
+.SH ENVIRONMENT
+.B CUPS
+commands use the following environment variables to override the default locations of files and so forth. For security reasons, these environment variables are ignored for setuid programs:
+.TP 5
+CUPS_SERVER
+The hostname/IP address and port number of the CUPS scheduler (hostname:port or ipaddress:port).
+.TP 5
+CUPS_ANYROOT
+Whether to allow any X.509 certificate root (Y or N).
+.TP 5
+CUPS_CACHEDIR
+The directory where semi-persistent cache files can be found.
+.TP 5
+CUPS_DATADIR
+The directory where data files can be found.
+.TP 5
+CUPS_ENCRYPTION
+The default level of encryption (Always, IfRequested, Never, Required).
+.TP 5
+CUPS_EXPIREDROOT
+Whether to allow expired X.509 certificate roots (Y or N).
+.TP 5
+CUPS_EXPIREDCERTS
+Whether to allow expired X.509 certificates (Y or N).
+.TP 5
+CUPS_GSSSERVICENAME
+The Kerberos service name used for authentication.
+.TP 5
+CUPS_SERVERBIN
+The directory where server helper programs, filters, backend, etc. can be found.
+.TP 5
+CUPS_SERVERROOT
+The root directory of the server.
+.TP 5
+CUPS_STATEDIR
+The directory where state files can be found.
+.TP 5
+CUPS_USER
+Specifies the name of the user for print requests.
+.TP 5
+HOME
+Specifies the home directory of the current user.
+.TP 5
+IPP_PORT
+Specifies the default port number for IPP requests.
+.TP 5
+LOCALEDIR
+Specifies the location of localization files.
+.TP 5
+LPDEST
+Specifies the default print queue (System V standard).
+.TP 5
+PRINTER
+Specifies the default print queue (Berkeley standard).
+.TP 5
+TMPDIR
+Specifies the location of temporary files.
+.SH FILES
+~/.cups/client.conf, ~/.cups/lpoptions
+.SH CONFORMING TO
+.B CUPS
+conforms to the Internet Printing Protocol version 2.1 and implements the Berkeley and System V UNIX print commands.
+.SH SEE ALSO
+.BR cancel (1), client.conf (7), cupsctl (8), cupsd (8), lp (1), lpadmin (8), lpinfo (8), lpoptions (1), lpr (1), lprm (1), lpq (1), lpstat (1),
+http://localhost:631/help,
+http://www.CUPS.org,
+http://www.pwg.org/ipp
+.SH COPYRIGHT
+Copyright \[co] 2007-2014 by Apple Inc.
+.\"
+.\" End of "$Id$".
+.\"
index ff3ddcdd34275e66c9466e59f85bfd41ba20dd1c..738fde8cac66251bb7bb4ce2105a8b49a222c9dd 100644 (file)
@@ -158,7 +158,7 @@ application/postscript).
 .TP 5
 CUPS_CACHEDIR
 .br
-The directory for semi-persistent cache files can be found.
+The directory where semi-persistent cache files can be found.
 .TP 5
 CUPS_DATADIR
 .br
index d498903b158a40075a0fb043e0cead6c17391761..61cc654746c04fe772215714ce3530bebef2224c 100644 (file)
@@ -912,12 +912,20 @@ html_fputs(const char *s,         /* I  - String */
       * Embed URL...
       */
 
+      char temp[1024];                 /* Temporary string */
       const char *end = s + 6;         /* End of URL */
 
       while (*end && !isspace(*end & 255))
        end ++;
 
-      fprintf(fp, "<a href=\"%*s\">%*s</a>", (int)(end - s), s, (int)(end - s), s);
+      if (end[-1] == ',' || end[-1] == '.')
+        end --;
+
+      strlcpy(temp, s, sizeof(temp));
+      if ((size_t)(end -s) < sizeof(temp))
+        temp[end - s] = '\0';
+
+      fprintf(fp, "<a href=\"%s\">%s</a>", temp, temp);
       s = end;
     }
     else