-<HTML>
+<!DOCTYPE html>
+<html>
<!-- SECTION: Getting Started -->
-<HEAD>
- <TITLE>Using Network Printers</TITLE>
-</HEAD>
-<BODY>
+ <head>
+ <title>Using Network Printers</title>
+ <link rel="stylesheet" type="text/css" href="../cups-printable.css">
+ </head>
+ <body>
+ <h1 class="title">Using Network Printers</h1>
-<P>This help document describes how to discover, configure, and use TCP/IP network printers with CUPS.</P>
+ <p>This help document describes how to discover, configure, and use TCP/IP network printers with CUPS.</p>
-<H2 CLASS="title"><A NAME="ADDRESS">Getting the IP Address</A></H2>
+ <h2 class="title" id="AUTOMATIC">Automatic Configuration Using Bonjour</h2>
-<P>Every network printer or print server has a unique Internet Protocol (IP) address associated with it. This address is either configured manually or set using an automatic network protocol such as the <A HREF="#BOOTP">Boot Protocol (BOOTP)</A>, <A HREF="#DHCP">Dynamic Host Control Protocol (DHCP)</A>, Reverse Address Resolution Protocol (RARP), or ZeroConf.</P>
+ <p>Most network printers support a protocol known as Bonjour, which is a combination of zero-configuration networking ("ZeroConf"), multicast DNS (mDNS), and DNS service discovery (DNS-SD) standards published by the Internet Engineering Task Force (IETF), the same group that defined TCP/IP and all of the networking we use today.</p>
-<P>You can normally find the IP address of a printer on the printer's control panel or by printing the configuration or status page. The <A HREF="#SNMP">Simple Network Management Protocol (SNMP)</A> can also be used to get the IP address remotely, which happens automatically when you visit the CUPS administration web page or choose an available CUPS device when adding a printer.</P>
+ <p>A printer that supports Bonjour can be found automatically using the <code>dnssd</code> backend. Run the <code>lpinfo(8)</code> command to find your printer's URI:</p>
+ <pre class="command">lpinfo --include-schemes dnssd -v
+network dnssd://Acme%20Laser%20Pro._ipp._tcp.local./?uuid=545253fb-1cb7-4d8d-98ed-ab6cd607cea7
+network dnssd://Bar99._printer.tcp.local./?uuid=f9efff58-9086-4c95-accb-81dee876a475
+network dnssd://Example%20EX-42._ipps._tcp.local./?uuid=4a0c67ad-2824-4ddf-9115-7d4226c5fe65
+network dnssd://Foo%20Fighter-1969._pdl-datastream._tcp.local./?uuid=4e216bea-c3de-4f65-a710-c99e11c80d2b</pre>
-<H2 CLASS="title"><A NAME="CONFIG">Configuring the IP Address</A></H2>
+ <p>You can then <a href="admin.html#PRINTERS">add a printer</a> using the URI reported.</p>
-<P>When you first install a network printer or print server on your LAN, you need to set the Internet Protocol ("IP") address. Most higher-end "workgroup" printers allow you to set the address through the printer control panel. However, if you have many printers you will want to assign the addresses remotely - this makes administration a bit easier and avoids assigning duplicate addresses accidentally.</P>
-<P>To setup your printer or print server for remote address assignment, you'll need the Ethernet Media Access Control ("MAC") address, also sometimes called a node address, and the IP address you want to use for the device. The Ethernet MAC address can often be found on the printer test page or bottom of the print server.</P>
+ <h2 class="title" id="MANUAL">Manual Configuration Using IP Addresses</h2>
-<H3><A NAME="DHCP">Configuring the IP Address Using DHCP</A></H3>
+ <p>You can also manually configure a printer using its Internet Protocol v4 (IPv4) address. This address is either configured manually ("static IP") through the printer's control panel or set using an automatic network protocol such as the Dynamic Host Control Protocol (DHCP) or ZeroConf.</p>
-<P>The DHCP protocol is the usual way of setting the IP address of a printer on a managed network. Using the standard <TT>dhcpd(8)</TT> program supplied with UNIX you simply need to add a line to the <VAR>/etc/dhcpd.conf</VAR> file:</P>
+ <blockquote><b>Note:</b> Configuring a printer using an IP address set using DHCP or ZeroConf is not recommended since the address will change every time the printer is turned on or after long periods of inactivity. Thus, every time the address changes you will need to modify the print queue using the <code>lpadmin</code> command.</blockquote>
-<PRE CLASS="command">
-host <I>hostname</I> {
- hardware ethernet <I>mac-address</I>;
- fixed-address <I>ip-address</I>;
-}
-</PRE>
+ <h3>Finding the IP Address</h3>
-<P>Make sure that the hostname you use is also listed in the <VAR>/etc/hosts</VAR> file or is registered with your DNS server.</P>
+ <p>You can normally find the IP address of a printer on the printer's control panel or by printing the configuration or status page. The <a href="#SNMP">Simple Network Management Protocol (SNMP)</a> can also be used to get the IP address remotely. To test that the IP address has been successfully assigned and that the printer is properly connected to your LAN or Wi-Fi network, type:</p>
-<H3><A NAME="BOOTP">Configuring the IP Address Using BOOTP</A></H3>
+ <pre class="command">ping ip-address</pre>
-<P>The BOOTP protocol is used when you need to provide additional information such as the location of a configuration file to the network interface. Using the standard <TT>bootpd(8)</TT> program supplied with UNIX you simply need to add a line to the <VAR>/etc/bootptab</VAR> file; for IRIX:</P>
+ <p>where "ip-address" is the address reported by the printer's control panel, configuration page, and/or status page. If the connection is working properly you will see something like:</p>
-<PRE CLASS="command">
-myprinter 08:00:69:00:12:34 192.0.2.2 <VAR>myprinter.boot</VAR>
-</PRE>
+ <pre class="command">ping 10.0.1.42
+PING 10.0.1.42 (10.0.1.42): 56 data bytes
+64 bytes from 10.0.1.42: icmp_seq=0 ttl=15 time=1.123 ms
+64 bytes from 10.0.1.42: icmp_seq=1 ttl=15 time=2.034 ms
+64 bytes from 10.0.1.42: icmp_seq=2 ttl=15 time=1.765 ms
+64 bytes from 10.0.1.42: icmp_seq=3 ttl=15 time=1.234 ms
+...</pre>
-<P>Newer versions of <TT>bootpd</TT> use a different format:</P>
+ <p>If the connection is not working properly you will see something like:</p>
+
+ <pre class="command">ping 10.0.1.42
+PING 10.0.1.42 (10.0.1.42): 56 data bytes
+Request timeout for icmp_seq 0
+Request timeout for icmp_seq 1
+...</pre>
-<PRE CLASS="command">
-myprinter:ha=080069001234:ip=192.0.2.2:<VAR>t144=myprinter.boot</VAR>
-</PRE>
+ <p>Press <kbd>CTRL+C</kbd> to quit the <code>ping</code> command.</p>
-<P>The <VAR>myprinter.boot</VAR> file resides in the <VAR>/usr/local/boot</VAR> directory by default. If you do not need to provide a boot file you may leave the last part of the line blank.</P>
+ <blockquote><b>Note:</b> If the command does not show responses from the printer, verify that the printer or print server is powered on and connected to the same LAN or Wi-Fi network as your computer. For LAN connections, also verify that your network cabling is good.</blockquote>
-<BLOCKQUOTE><B>Note:</B> Some versions of UNIX do not enable the BOOTP service by default. The <VAR>/etc/inetd.conf</VAR> or <VAR>/etc/xinetd.d/bootp</VAR> file usually contains a line for the BOOTP service that can be uncommented if needed.</BLOCKQUOTE>
+ <h3>Choosing a Network Protocol (Backend)</h3>
-<H2 CLASS="title"><A NAME="VERIFY">Verifying the Printer Connection</A></H2>
+ <p>CUPS supports most network printers using one of three TCP/IP-based protocols: <a href="#SOCKET">AppSocket</a>, <a href="#IPP">Internet Printing Protocol</a>, and <a href="#LPD">Line Printer Daemon</a>. The following sections describe the options for each of the backends.</p>
-<P>To test that the IP address has been successfully assigned and
-that the printer is properly connected to your LAN, type:</P>
-
-<PRE CLASS="command">
-<KBD>ping ip-address</KBD>
-</PRE>
-<P>If the connection is working properly you will see something
-like:</P>
+ <h4 id="SOCKET">AppSocket Protocol (aka JetDirect)</h4>
-<PRE CLASS="command">
-<KBD>ping myprinter</KBD>
-PING myprinter (192.0.2.2): 56 data bytes
-64 bytes from 192.0.2.2: icmp_seq=0 ttl=15 time=5 ms
-64 bytes from 192.0.2.2: icmp_seq=1 ttl=15 time=3 ms
-64 bytes from 192.0.2.2: icmp_seq=2 ttl=15 time=3 ms
-64 bytes from 192.0.2.2: icmp_seq=3 ttl=15 time=3 ms
-</PRE>
+ <p>The AppSocket protocol (sometimes also called the JetDirect protocol, owing to its origins with the HP JetDirect network interfaces) is the simplest and fastest network protocol used for printers. AppSocket printing normally happens over port 9100 and uses the <code>socket</code> backend. Device URIs for the <code>socket</code> backend look like this:</p>
-<P>If not, verify that the printer or print server is connected
-to the LAN, it is powered on, the LAN cabling is good, and the IP
-address is set correctly. You can usually see the current IP
-address and network status by printing a configuration or test
-page on the device.</P>
-
-
-<H2 CLASS="title"><A NAME="PROTOCOLS">Network Protocols Supported by CUPS</H2>
-
-<P>CUPS supports most network printers using one of three TCP/IP-based protocols. Printer discovery is currently accomplished using the SNMP protocol, however future versions of CUPS will also include support for multicast DNS service discovery as well.</P>
-
-<H3><A NAME="SOCKET">AppSocket Protocol</A></H3>
-
-<P>The AppSocket protocol (sometimes also called the JetDirect protocol, owing to its origins with the HP JetDirect network interfaces) is the simplest, fastest, and generally the most reliable network protocol used for printers. AppSocket printing normally happens over port 9100 and uses the <tt>socket</tt> URI scheme:</P>
-
-<PRE>
-socket://<i>ip-address-or-hostname</i>
-socket://<i>ip-address-or-hostname</i>?waiteof=false
-socket://<i>ip-address-or-hostname</i>:<i>port-number</i>
-socket://<i>ip-address-or-hostname</i>:<i>port-number</i>?waiteof=false
-</PRE>
-
-<P>The "waiteof" option controls whether the <tt>socket</tt> backend waits for the printer to complete the printing of the job. The default is to wait.</P>
-
-<H3><A NAME="IPP">Internet Printing Protocol (IPP)</A></H3>
-
-<P>IPP is the only protocol that CUPS supports natively and is supported by some network printers and print servers. However, since many printers do not implement IPP properly, only use IPP when the vendor actually documents official support for it. IPP printing normally happens over port 631 and uses the <tt>http</tt> and <tt>ipp</tt> URI schemes:</P>
-
-<PRE>
-http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
-http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
-http://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
-ipp://<i>ip-address-or-hostname</i>/<i>resource</i>
-ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value</i>
-ipp://<i>ip-address-or-hostname</i>/<i>resource</i>?<i>option=value&option=value</i>
-ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>
-ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value</i>
-ipp://<i>ip-address-or-hostname</i>:<i>port-number</i>/<i>resource</i>?<i>option=value&option=value</i>
-</PRE>
-
-<P>The <tt>ipp</tt> backend supports many options, which are summarized in <A HREF="#TABLE2">Table 2</A>.</P>
-
-<DIV CLASS="table"><TABLE SUMMARY="IPP URI Options">
-<CAPTION>Table 2: <A NAME="TABLE2">IPP URI Options</A></CAPTION>
-<THEAD>
-<TR>
- <TH>Option</TH>
- <TH>Description</TH>
-</TR>
-</THEAD>
-<TBODY>
-<TR>
- <TD><TT>compression=gzip</TT></TD>
- <TD>Specifies that print data should be compressed before sending.</TD>
-</TR>
-<TR>
- <TD><TT>encryption=always</TT></TD>
- <TD>Specifies that the connection to the IPP server should be encrypted using SSL.</TD>
-</TR>
-<TR>
- <TD><TT>encryption=ifrequested</TT></TD>
- <TD>Specifies that the connection to the IPP server should only be encrypted if the server requests it.</TD>
-</TR>
-<TR>
- <TD><TT>encryption=never</TT></TD>
- <TD>Specifies that the connection to the IPP server should not be encrypted.</TD>
-</TR>
-<TR>
- <TD><TT>encryption=required</TT></TD>
- <TD>Specifies that the connection to the IPP server should be encrypted using TLS.</TD>
-</TR>
-<TR>
- <TD><TT>version=1.0</TT></TD>
- <TD>Specifies that version 1.0 of the IPP protocol should be used instead of the default version 1.1.</TD>
-</TR>
-<TR>
- <TD><TT>waitjob=false</TT></TD>
- <TD>Specifies that the IPP backend should not wait for the job to complete.</TD>
-</TR>
-<TR>
- <TD><TT>waitprinter=false</TT></TD>
- <TD>Specifies that the IPP backend should not wait for the printer to become idle before sending the print job.</TD>
-</TR>
-</TBODY>
-</TABLE></DIV>
-
-<H3><A NAME="LPD">Line Printer Daemon (LPD) Protocol</A></H3>
-
-<P>LPD is the original network printing protocol and is supported by many network printers. Due to limitations in the LPD protocol, we do not recommend using it if the printer or server supports one of the other protocols. LPD printing normally happens over port 515 and uses the <tt>lpd</tt> URI scheme:</P>
-
-<PRE>
-lpd://<i>ip-address-or-hostname</i>/<i>queue</i>
-lpd://<i>ip-address-or-hostname</i>/<i>queue</i>?<i>option=value</i>
-lpd://<i>ip-address-or-hostname</i>/<i>queue</i>?<i>option=value&option=value</i>
-</PRE>
-
-<P><A HREF="#TABLE3">Table 3</A> summarizes the options supported by the <tt>lpd</tt> backend.</P>
-
-<DIV CLASS="table"><TABLE SUMMARY="LPD URI Options">
-<CAPTION>Table 3: <A NAME="TABLE3">LPD URI Options</A></CAPTION>
-<THEAD>
-<TR>
- <TH>Option</TH>
- <TH>Description</TH>
-</TR>
-</THEAD>
-<TBODY>
-<TR>
- <TD><TT>banner=on</TT></TD>
- <TD>Specifies that a banner page should be printed by the server.</TD>
-</TR>
-<TR>
- <TD><TT>contimeout=<I>seconds</I></TT></TD>
- <TD>Specifies the number of seconds to wait for the connection to the server to complete.</TD>
-</TR>
-<TR>
- <TD><TT>format=c</TT></TD>
- <TD>Specifies that the print data is a CIF file.</TD>
-</TR>
-<TR>
- <TD><TT>format=d</TT></TD>
- <TD>Specifies that the print data is a DVI file.</TD>
-</TR>
-<TR>
- <TD><TT>format=f</TT></TD>
- <TD>Specifies that the print data is a plain text file.</TD>
-</TR>
-<TR>
- <TD><TT>format=g</TT></TD>
- <TD>Specifies that the print data is a Berkeley plot file.</TD>
-</TR>
-<TR>
- <TD><TT>format=l</TT></TD>
- <TD>Specifies that the print data is a raw (preformatted) print file.</TD>
-</TR>
-<TR>
- <TD><TT>format=n</TT></TD>
- <TD>Specifies that the print data is a ditroff file.</TD>
-</TR>
-<TR>
- <TD><TT>format=o</TT></TD>
- <TD>Specifies that the print data is a PostScript file.</TD>
-</TR>
-<TR>
- <TD><TT>format=p</TT></TD>
- <TD>Specifies that the print data is a plain text file that should be "pretty" printed with a header and footer.</TD>
-</TR>
-<TR>
- <TD><TT>format=r</TT></TD>
- <TD>Specifies that the print data is a FORTRAN carriage control file.</TD>
-</TR>
-<TR>
- <TD><TT>format=t</TT></TD>
- <TD>Specifies that the print data is a troff Graphic Systems C/A/T phototypesetter file.</TD>
-</TR>
-<TR>
- <TD><TT>format=v</TT></TD>
- <TD>Specifies that the print data is a Sun raster file.</TD>
-</TR>
-<TR>
- <TD><TT>order=data,control</TT></TD>
- <TD>Specifies that the print data files should be sent before the control file.</TD>
-</TR>
-<TR>
- <TD><TT>reserve=none</TT></TD>
- <TD>Specifies that the backend should not reserve a source port.</TD>
-</TR>
-<TR>
- <TD><TT>reserve=rfc1179</TT></TD>
- <TD>Specifies that the backend should reserve a source port from 721 to 731 as required by RFC 1179.</TD>
-</TR>
-<TR>
- <TD><TT>sanitize_title=no</TT></TD>
- <TD>Specifies that the job title string should not be restricted to ASCII characters.</TD>
-</TR>
-<TR>
- <TD><TT>sanitize_title=yes</TT></TD>
- <TD>Specifies that the job title string should be restricted to ASCII characters.</TD>
-</TR>
-<TR>
- <TD><TT>timeout=<I>seconds</I></TT></TD>
- <TD>Specifies the number of seconds to wait for LPD commands to complete.</TD>
-</TR>
-</TBODY>
-</TABLE></DIV>
-
-
-<H3><A NAME="URI">Common Network Printer URIs</A></H3>
-
-<P>Once you have set the IP address you can access the printer or print server using the <TT>ipp</TT>, <TT>lpd</TT>, or <TT>socket</TT> backends. <A HREF="#TABLE1">Table 1</A> shows a list of common network interfaces and printer servers and the settings you should use with CUPS:</P>
-
-<DIV CLASS="table"><TABLE SUMMARY="Common Device URIs">
-<CAPTION>Table 1: <A NAME="TABLE1">Common Device URIs</A></CAPTION>
-<THEAD>
-<TR>
- <TH>Model/Manufacturer</TH>
- <TH>Device URI(s)</TH>
-</TR>
-</THEAD>
-<TBODY>
-<TR>
- <TD>Apple LaserWriter</TD>
- <TD>lpd://<I>address</I>/PASSTHRU</TD>
-</TR>
-<TR>
- <TD>Axis w/o IPP<BR>
- Axis OfficeBasic<BR>
- <A HREF="#AXIS">(see directions)</A></TD>
- <TD>socket://<I>address</I>:9100<BR>
- socket://<I>address</I>:9101<BR>
- socket://<I>address</I>:9102</TD>
-</TR>
-<TR>
- <TD>Axis w/IPP</TD>
- <TD>ipp://<I>address</I>/LPT1<BR>
- ipp://<I>address</I>/LPT2<BR>
- ipp://<I>address</I>/COM1</TD>
-</TR>
-<TR>
- <TD>Castelle LANpress<SUP>TM</SUP></TD>
- <TD>lpd://<I>address</I>/pr1<BR>
- lpd://<I>address</I>/pr2<BR>
- lpd://<I>address</I>/pr3</TD>
-</TR>
-<TR>
- <TD>DPI NETPrint</TD>
- <TD>lpd://<I>address</I>/pr1<BR>
- lpd://<I>address</I>/pr2<BR>
- lpd://<I>address</I>/pr3</TD>
-</TR>
-<TR>
- <TD>DLink DP-301P+</TD>
- <TD>socket://<I>address</I></TD>
-</TR>
-<TR>
- <TD>EFI® Fiery® RIP</TD>
- <TD>lpd://<I>address</I>/print</TD>
-</TR>
-<TR>
- <TD>EPSON® Multiprotocol Ethernet Interface Board</TD>
- <TD>socket://<I>address</I></TD>
-</TR>
-<TR>
- <TD>Extended System ExtendNET</TD>
- <TD>lpd://<I>address</I>/pr1<BR>
- lpd://<I>address</I>/pr2<BR>
- lpd://<I>address</I>/pr3</TD>
-</TR>
-<TR>
- <TD>Hewlett Packard JetDirect</TD>
- <TD>socket://<I>address</I>:9100<BR>
- socket://<I>address</I>:9101<BR>
- socket://<I>address</I>:9102</TD>
-</TR>
-<TR>
- <TD>Intel® NetportExpress XL, PRO/100</TD>
- <TD>lpd://<I>address</I>/LPT1_PASSTHRU<BR>
- lpd://<I>address</I>/LPT2_PASSTHRU<BR>
- lpd://<I>address</I>/COM1_PASSTHRU</TD>
-</TR>
-<TR>
- <TD>Lexmark<SUP>TM</SUP> MarkNet</TD>
- <TD>lpd://<I>address</I>/ps</TD>
-</TR>
-<TR>
- <TD>Linksys EtherFast®<BR>
- <A HREF="#LINKSYS">(see directions)</A></TD>
- <TD>socket://<I>address</I>:4010<BR>
- socket://<I>address</I>:4020<BR>
- socket://<I>address</I>:4030</TD>
-</TR>
-<TR>
- <TD>Linksys PSUS4</TD>
- <TD>lpd://<I>address</I>/lp</TD>
-</TR>
-<TR>
- <TD>Kodak®</TD>
- <TD>lpd://<I>address</I>/ps</TD>
-</TR>
-<TR>
- <TD>Netgear WGPS606</TD>
- <TD>lpd://<I>address</I>/L1<BR>
- lpd://<I>address</I>/L2</TD>
-</TR>
-<TR>
- <TD>QMS® CrownNet<SUP>TM</SUP></TD>
- <TD>lpd://<I>address</I>/ps</TD>
-</TR>
-<TR>
- <TD>Tektronix® PhaserShare<SUP>TM</SUP></TD>
- <TD>socket://<I>address</I>:9100</TD>
-</TR>
-<TR>
- <TD>XEROX® 4512 NIC</TD>
- <TD>lpd://<I>address</I>/PORT1</TD>
-</TR>
-<TR>
- <TD>XEROX® XNIC</TD>
- <TD>lpd://<I>address</I>/PASSTHRU</TD>
-</TR>
-<TR>
- <TD>XEROX® (most others)</TD>
- <TD>socket://<I>address</I>:5503</TD>
-</TR>
-</TBODY>
-</TABLE></DIV>
-
-
-<H2 CLASS="title"><A NAME="SNMP">Troubleshooting SNMP Discovery Problems</A></H2>
-
-<P>Whenever you view the administration web page or a list of supported device URIs, the <tt>snmp</tt> backend will probe the local network(s) using Simple Network Management Protocol (SNMP) broadcasts. Printers that respond to these broadcasts are then interrogated for the make and model and supported protocols, yielding a device URI that can be used to add the printer.</P>
-
-<P>That said, the SNMP requests sometimes expose problems in vendor SNMP or IPP implementations. If you are experiencing long delays in loading the CUPS web interface administration page, or if you don't see your printer listed, the following instructions will help you to diagnose those problems and/or provide important feedback to the CUPS developers so that we can correct problems and improve the SNMP backend in future releases.</P>
-
-<H3>Quick Fixes</H3>
-
-<P>If you don't use "public" as your community name, create a text file called <VAR>/etc/cups/snmp.conf</VAR> and put the following line in it:</P>
-
-<PRE CLASS="command">
-Community <I>your community name</I>
-</PRE>
-
-<P>If you have more than one community name, list them all on separate lines.</P>
-
-<P>If you don't support SNMP v1 on your network, you are currently "out of luck". That said, we will be adding v2, v2c, and v3 support in future CUPS releases once we have a handle on the actual requirements people have for such things. Please file or update an <A HREF="http://www.cups.org/str.php">SNMP enhancement request</A> with <em>specific</em> requirements you have - what you need supported, why you need it supported, and how you would like to see the functionality provided/exposed - so that we can do it "right" the first time.</P>
-
-<H3>Basic Debugging</H3>
-
-<P>The SNMP backend supports a debugging mode that is activated by running it from a shell prompt. If you are using Bash (/bin/bash), Bourne shell (/bin/sh), Korn shell (/bin/ksh), or Z shell (/bin/zsh), you can run the following command to get a verbose log of the SNMP backend:</P>
-
-<PRE CLASS="command">
-CUPS_DEBUG_LEVEL=2 /usr/lib/cups/backend/snmp 2>&1 | tee snmp.log
-</PRE>
-
-<P>For C shell (/bin/csh) and TCsh (/bin/tcsh), use the following command instead:</P>
-
-<PRE CLASS="command">
-(setenv CUPS_DEBUG_LEVEL 2; /usr/lib/cups/backend/snmp) |& tee snmp.log
-</PRE>
-
-<P>On MacOS X you'll find the SNMP backend in /usr/libexec/cups/backend instead:</P>
-
-<PRE CLASS="command">
-CUPS_DEBUG_LEVEL=2 /usr/libexec/cups/backend/snmp 2>&1 | tee snmp.log
-</PRE>
-
-<P>The output will look something like this:</P>
-
-<PRE STYLE="margin-left: 36pt">
- 1 INFO: Using default SNMP Address @LOCAL
+ <pre class="example">socket://ip-address
+socket://ip-address/?contimeout=30
+socket://ip-address/?waiteof=false
+socket://ip-address/?contimeout=30&waiteof=false
+socket://ip-address:port-number/?...</pre>
+
+ <p>The "contimeout" option controls the number of seconds that the backend will wait to obtain a connection to the printer. The default is 1 week or 604800 seconds.</p>
+
+ <p>The "waiteof" option controls whether the <code>socket</code> backend waits for the printer to complete the printing of the job. The default is to wait (<code>waiteof=true</code>). Add <code>waiteof=false</code> to the URI to tell the backend not to wait.</p>
+
+ <blockquote><b>Note:</b> While the AppSocket protocol is simple and fast, it also offers no security and is often an attack vector with printers. Consider using the <a href="#IPP">Internet Printing Protocol</a> which supports encryption and other security features.</blockquote>
+
+
+ <h4 id="IPP">Internet Printing Protocol (IPP)</h4>
+
+ <p>IPP is the only protocol that CUPS supports natively and is supported by most network printers and print servers. IPP supports encryption and other security features over port 631 and uses the <code>http</code> (Windows), <code>ipp</code>, and <code>ipps</code> backends. Device URIs for these backends look like this:</p>
+
+ <pre class="example">http://ip-address-or-hostname:port-number/printers/name/.printer</i>
+ipp://ip-address/ipp/print
+ipp://ip-address-or-hostname/printers/name
+ipps://ip-address/ipp/print
+ipps://ip-address:443/ipp/print
+ipps://ip-address-or-hostname/printers/name</pre>
+
+ <p>The backends supports many options, which are summarized in <a href="#TABLE2">Table 2</a>. Like all backends, options are added to the end of the URI using the URL form encoding format, for example:</p>
+
+ <pre class="example">ipp://10.0.1.42/ipp/print?version=1.1
+ipps://10.0.1.42:443/ipp/print?waitjob=false&waitprinter=false</pre>
+
+ <div class="table"><table summary="IPP URI Options">
+ <caption>Table 2: <A NAME="TABLE2">IPP URI Options</a></caption>
+ <thead>
+ <tr>
+ <th>Option</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>contimeout=<I>seconds</I></code></td>
+ <td>Specifies the number of seconds to wait for the connection to the printer to complete (default 1 week or 604800 seconds).</td>
+ </tr>
+ <tr>
+ <td><code>encryption=always</code></td>
+ <td>Specifies that the connection to the IPP printer should be encrypted using SSL.</td>
+ </tr>
+ <tr>
+ <td><code>encryption=ifrequested</code></td>
+ <td>Specifies that the connection to the IPP printer should only be encrypted if the printer requests it.</td>
+ </tr>
+ <tr>
+ <td><code>encryption=never</code></td>
+ <td>Specifies that the connection to the IPP printer should not be encrypted.</td>
+ </tr>
+ <tr>
+ <td><code>encryption=required</code></td>
+ <td>Specifies that the connection to the IPP printer should be encrypted using TLS.</td>
+ </tr>
+ <tr>
+ <td><code>version=1.0</code></td>
+ <td>Specifies that version 1.0 of the IPP protocol should be used instead of the default version 2.0.</td>
+ </tr>
+ <tr>
+ <td><code>version=1.1</code></td>
+ <td>Specifies that version 1.1 of the IPP protocol should be used instead of the default version 2.0.</td>
+ </tr>
+ <tr>
+ <td><code>version=2.1</code></td>
+ <td>Specifies that version 2.1 of the IPP protocol should be used instead of the default version 2.0.</td>
+ </tr>
+ <tr>
+ <td><code>waitjob=false</code></td>
+ <td>Specifies that the IPP backend should not wait for the job to complete.</td>
+ </tr>
+ <tr>
+ <td><code>waitprinter=false</code></td>
+ <td>Specifies that the IPP backend should not wait for the printer to become idle before sending the print job.</td>
+ </tr>
+ </tbody>
+ </table></div>
+
+
+ <h4 id="LPD">Line Printer Daemon (LPD) Protocol (aka lpr)</h4>
+
+ <p>LPD is the original network printing protocol created for the Berkeley UNIX line printer daemon (spooler) and is supported by many network printers. LPD printing normally happens over port 515 and uses the <code>lpd</code> backend. Device URIsfor the <code>lpd</code> backend look like this:</p>
+
+ <pre class="example">lpd://ip-address/queue
+lpd://ip-address/queue?format=l
+lpd://ip-address/queue?format=l&reserve=rfc1179</pre>
+
+ <p><a href="#TABLE3">Table 3</a> summarizes the options supported by the <code>lpd</code> backend.</p>
+
+ <blockquote><b>Note:</b> Due to limitations in the LPD protocol, we do not recommend using it if the printer or server supports any of the other protocols. Like AppSocket, LPD offers no security and is a common attack vector. LPD also, by default, requires that the computer save a copy of the entire print job before sending it to the printer - this can result in gigabytes of print data being saved to disk before any printing happens, delaying print jobs and shortening the life of your mass storage device!</blockquote>
+
+ <div class="table"><table summary="LPD URI Options">
+ <caption>Table 3: <A NAME="TABLE3">LPD URI Options</a></caption>
+ <thead>
+ <tr>
+ <th>Option</th>
+ <th>Description</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td><code>banner=on</code></td>
+ <td>Specifies that a banner page should be printed by the printer.</td>
+ </tr>
+ <tr>
+ <td><code>contimeout=<I>seconds</I></code></td>
+ <td>Specifies the number of seconds to wait for the connection to the printer to complete (default 1 week or 604800 seconds).</td>
+ </tr>
+ <tr>
+ <td><code>format=f</code></td>
+ <td>Specifies that the print data is a plain text file.</td>
+ </tr>
+ <tr>
+ <td><code>format=o</code></td>
+ <td>Specifies that the print data is a PostScript file.</td>
+ </tr>
+ <tr>
+ <td><code>format=p</code></td>
+ <td>Specifies that the print data is a plain text file that should be "pretty" printed with a header and footer.</td>
+ </tr>
+ <tr>
+ <td><code>mode=stream</code></td>
+ <td>Specifies that the backend should stream print data to the printer and not wait for confirmation that the job has been successfully printed.</td>
+ </tr>
+ <tr>
+ <td><code>order=data,control</code></td>
+ <td>Specifies that the print data files should be sent before the control file.</td>
+ </tr>
+ <tr>
+ <td><code>reserve=none</code></td>
+ <td>Specifies that the backend should not reserve a source port.</td>
+ </tr>
+ <tr>
+ <td><code>reserve=rfc1179</code></td>
+ <td>Specifies that the backend should reserve a source port from 721 to 731 as required by RFC 1179.</td>
+ </tr>
+ <tr>
+ <td><code>sanitize_title=no</code></td>
+ <td>Specifies that the job title string should not be restricted to ASCII alphanumeric and space characters.</td>
+ </tr>
+ <tr>
+ <td><code>sanitize_title=yes</code></td>
+ <td>Specifies that the job title string should be restricted to ASCII alphanumeric and space characters.</td>
+ </tr>
+ <tr>
+ <td><code>timeout=<I>seconds</I></code></td>
+ <td>Specifies the number of seconds to wait for LPD commands to complete (default 5 minutes or 300 seconds).</td>
+ </tr>
+ </tbody>
+ </table></div>
+
+
+ <h2 class="title" id="SNMP">Finding Printers Using SNMP</h2>
+
+ <p>Whenever you view the administration web page or a list of supported device URIs, the <code>snmp</code> backend can probe the local network(s) using Simple Network Management Protocol (SNMP) v1 broadcasts. Printers that respond to these broadcasts are then interrogated for the make, model, and supported protocols, yielding a device URI that can be used to add the printer.</p>
+
+ <p>The <a href="man-cups-snmp.conf.html"><var>/etc/cups/snmp.conf</var></a> file configures the <code>snmp</code> backend. Add the following line to enable discovery using the <code>snmp</code> backend:</p>
+
+ <pre class="example">Address @LOCAL</pre>
+
+ <p>If you don't use "public" as your community name, change the <code>Community</code> line as well:</p>
+
+ <pre class="example">Community <I>your community name</I></pre>
+
+ <blockquote><b>Note:</b> The <code>snmp</code> backend will not be able to find any printers on your network if SNMP v1 or broadcasting are disabled on your network. Also, broadcasts are typically limited to the local subnet, so printers on different networks cannot be discovered using SNMP.</blockquote>
+
+ <h3>Troubleshooting SNMP Problems</h3>
+
+ <p>The <code>snmp</code> backend sometimes exposes problems in vendor implementations. If you are experiencing long delays in loading the CUPS web interface administration page, or if you don't see your printer listed, the following instructions will help you to diagnose those problems and/or provide important feedback to the CUPS developers so that we can correct problems and improve the <code>snmp</code> backend in future releases.</p>
+
+ <p>The SNMP backend supports a debugging mode that is activated by running it from a shell prompt. Run the following command to get a verbose log of the <code>snmp</code> backend:</p>
+
+ <pre class="command">CUPS_DEBUG_LEVEL=2 /usr/lib/cups/backend/snmp @LOCAL 2>&1 | tee snmp.log</pre>
+
+ <p>On macOS you'll find the backend in /usr/libexec/cups/backend instead:</p>
+
+ <pre class="command">CUPS_DEBUG_LEVEL=2 /usr/libexec/cups/backend/snmp @LOCAL 2>&1 | tee snmp.log</pre>
+
+ <p>The output will look something like this:</p>
+
+ <pre class="example"> 1 INFO: Using default SNMP Address @LOCAL
2 INFO: Using default SNMP Community public
3 DEBUG: Scanning for devices in "public" via "@LOCAL"...
- 4 DEBUG: 0.000 Sending 46 bytes to 192.168.2.255...
+ 4 DEBUG: 0.000 Sending 46 bytes to 10.0.1.255...
5 DEBUG: SEQUENCE 44 bytes
6 DEBUG: INTEGER 1 bytes 0
7 DEBUG: OCTET STRING 6 bytes "public"
13 DEBUG: SEQUENCE 15 bytes
14 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.2.1
15 DEBUG: NULL VALUE 0 bytes
-16 DEBUG: 0.001 Received 55 bytes from 192.168.2.229...
+16 DEBUG: 0.001 Received 55 bytes from 10.0.1.42...
17 DEBUG: community="public"
18 DEBUG: request-id=1149539174
19 DEBUG: error-status=0
28 DEBUG: SEQUENCE 24 bytes
29 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.2.1
30 DEBUG: OID 9 bytes .1.3.6.1.2.1.25.3.1.5
-31 DEBUG: add_cache(addr=0xbfffe170, addrname="192.168.2.229",
- uri="(null)", id="(null)", make_and_model="(null)")
-32 DEBUG: 0.002 Sending 46 bytes to 192.168.2.229...
+31 DEBUG: add_cache(addr=0xbfffe170, addrname="10.0.1.42", uri="(null)", id="(null)", make_and_model="(null)")
+32 DEBUG: 0.002 Sending 46 bytes to 10.0.1.42...
33 DEBUG: SEQUENCE 44 bytes
34 DEBUG: INTEGER 1 bytes 0
35 DEBUG: OCTET STRING 6 bytes "public"
41 DEBUG: SEQUENCE 15 bytes
42 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.3.1
43 DEBUG: NULL VALUE 0 bytes
-44 DEBUG: 0.003 Received 69 bytes from 192.168.2.229...
+44 DEBUG: 0.003 Received 69 bytes from 10.0.1.42...
45 DEBUG: community="public"
46 DEBUG: request-id=1149539175
47 DEBUG: error-status=0
55 DEBUG: SEQUENCE 40 bytes
56 DEBUG: SEQUENCE 38 bytes
57 DEBUG: OID 11 bytes .1.3.6.1.2.1.25.3.2.1.3.1
-58 DEBUG: OCTET STRING 23 bytes "HP LaserJet 4000
- Series"
-59 DEBUG: 1.001 Probing 192.168.2.229...
-60 DEBUG: 1.001 Trying socket://192.168.2.229:9100...
-61 DEBUG: 192.168.2.229 supports AppSocket!
+58 DEBUG: OCTET STRING 23 bytes "HP LaserJet 4000 Series"
+59 DEBUG: 1.001 Probing 10.0.1.42...
+60 DEBUG: 1.001 Trying socket://10.0.1.42:9100...
+61 DEBUG: 10.0.1.42 supports AppSocket!
62 DEBUG: 1.002 Scan complete!
-63 network socket://192.168.2.229 "HP LaserJet 4000 Series"
- "HP LaserJet 4000 Series 192.168.2.229" ""
-</PRE>
+63 network socket://10.0.1.42 "HP LaserJet 4000 Series" "HP LaserJet 4000 Series 10.0.1.42" ""</pre>
+
+ <p>The first two lines are just informational and let you know that the default community name and address are being used. Lines 3-15 contain the initial SNMP query for the device type OID (.1.3.6.1.2.1.25.3.2.1.2.1) from the Host MIB.</p>
+
+ <p>Lines 16-31 show the response we got from an HP LaserJet 4000 network printer. At this point we discover that it is a printer device and then send another SNMP query (lines 32-43) for the device description OID (.1.3.6.1.2.1.25.3.2.1.3.1) from the Host MIB as well.</p>
+
+ <p>Lines 44-58 show the response to the device description query, which tells us that this is an HP LaserJet 4000 Series printer.</p>
+
+ <p>On line 59 we start our active connection probe and discover that this print server supports the AppSocket (JetDirect) protocol on port 9100.</p>
+
+ <p>Finally, line 63 shows the device information line for the print server that is sent to CUPS.</p>
-<H3>Dissecting the Output</H3>
+ <p>If you don't see your printer listed, or the wrong information is listed, then you need to gather more information on the printer. The easiest way to do this is to run the snmpwalk command:</p>
-<P>The first two lines are just informational and let you know that the default community name and address are being used. Lines 3-15 contain the initial SNMP query for the device type OID (.1.3.6.1.2.1.25.3.2.1.2.1) from the Host MIB.</P>
+ <pre class="command">snmpwalk -Cc -v 1 -c public ip-address | tee snmpwalk.log</pre>
-<P>Lines 16-31 show the response we got from an HP LaserJet 4000 network printer. At this point we discover that it is a printer device and then send another SNMP query (lines 32-43) for the device description OID (.1.3.6.1.2.1.25.3.2.1.3.1) from the Host MIB as well.</P>
+ <p>where "ip-address" is the IP address of the printer or print server. You should see a <em>lot</em> of values stream by - the ones you want to see are:</p>
-<P>Lines 44-58 show the response to the device description query, which tells us that this is an HP LaserJet 4000 Series printer.</P>
-
-<P>On line 59 we start our active connection probe and discover that this print server supports the AppSocket (JetDirect) protocol on port 9100.</P>
-
-<P>Finally, line 63 shows the device information line for the print server that is sent to CUPS.</P>
-
-<H3>Reporting Problems</H3>
-
-If you don't see your printer listed, or the wrong information is listed, then you need to gather more information on the printer. The easiest way to do this is to run the snmpwalk command:
-
-<PRE CLASS="command">
-snmpwalk -Cc -v 1 -c public <I>ip-address</I> | tee snmpwalk.log
-</PRE>
-
-<P>where "ip-address" is the IP address of the printer or print server. You should see a <em>lot</em> of values stream by - the ones you want to see are:</P>
+ <pre class="example">HOST-RESOURCES-MIB::hrDeviceType.1 = OID: HOST-RESOURCES-TYPES::hrDevicePrinter
+HOST-RESOURCES-MIB::hrDeviceDescr.1 = STRING: HP LaserJet 4000 Series</pre>
-<PRE STYLE="margin-left: 36pt">
-HOST-RESOURCES-MIB::hrDeviceType.1 = OID: HOST-RESOURCES-TYPES::hrDevicePrinter
-HOST-RESOURCES-MIB::hrDeviceDescr.1 = STRING: HP LaserJet 4000 Series
-</PRE>
+ <p>The hrDeviceType line should show hrDevicePrinter; if not, then your printer or print server doesn't identify itself as a printer. The hrDeviceDescr line should provide a human-readable string for the make and model of the printer, although in some cases you'll just see something less useful like "Axis OfficeBASIC Parallel Print Server".</p>
-<P>The hrDeviceType line should show hrDevicePrinter; if not, then your printer or print server doesn't identify itself as a printer. The hrDeviceDescr line should provide a human-readable string for the make and model of the printer, although in some cases you'll just see something less useful like "Axis OfficeBASIC Parallel Print Server".</P>
-
-<P>Once you have collected the snmpwalk output, you should go to the <A HREF="http://www.cups.org/str.php">CUPS Bugs & Features page</A> to submit a feature request to support your printer or print server. Be sure to attach those two log files you created - they will help us to identify the SNMP values we need to look for.</P>
-
-
-<H2 CLASS="title"><A NAME="SERVERS">Configuring Print Servers</A></H2>
-
-<H3><A NAME="AXIS">Configuring Axis Print Servers</A></H3>
-
-<P>The Axis print servers can be configured using BOOTP or DHCP. However, on models that do not provide IPP support an additional step must be performed to configure the TCP/IP portion of the print server for use with CUPS.</P>
-
-<P>Each print server contains a configuration file named <VAR>config</VAR> that contains a list of network parameters used by the server. To modify this file you must first download it from the print server using the <TT>ftp(1)</TT> program:</P>
-
-<PRE CLASS="command">
-<KBD>ftp ip-address</KBD>
-Connected to ip-address.
-220 Axis NPS ### FTP Printer Server V#.## MON DD YEAR ready.
-ftp> <KBD>user root</KBD>
-331 User name ok, need password
-Password: <KBD>pass</KBD> <I>(this is not echoed)</I>
-230 User logged in
-ftp> <KBD>get config</KBD>
-local: config remote: config
-200 PORT command successful.
-150 Opening data connection for config (192,0,2,2),
-(mode ascii).
-226 Transfer complete.
-##### bytes received in #.## seconds (##### Kbytes/s)
-ftp> <KBD>quit</KBD>
-221 Goodbye.
-</PRE>
-
-<P>Next, edit the file with your favorite text editor and locate the lines beginning with:</P>
-
-<PRE CLASS="command">
-RTN_OPT. : YES
-RTEL_PR1. : 0
-RTEL_PR2. : 0
-RTEL_PR3. : 0
-RTEL_PR4. : 0
-RTEL_PR5. : 0
-RTEL_PR6. : 0
-RTEL_PR7. : 0
-RTEL_PR8. : 0
-</PRE>
-
-<P>Change the <TT>RTN_OPT</TT> line to read:</P>
-
-<PRE CLASS="command">
-RTN_OPT. : <KBD>NO</KBD>
-</PRE>
-
-<P>This disables the Reverse TELNET protocol and enables the standard TELNET protocol on the print server. Next, assign a port number for each parallel and serial port on the server as follows:</P>
-
-<PRE CLASS="command">
-RTEL_PR1. : <KBD>9100</KBD>
-RTEL_PR2. : <KBD>9101</KBD>
-RTEL_PR3. : <KBD>9102</KBD>
-RTEL_PR4. : <KBD>9103</KBD>
-RTEL_PR5. : <KBD>9104</KBD>
-RTEL_PR6. : <KBD>9105</KBD>
-RTEL_PR7. : <KBD>9106</KBD>
-RTEL_PR8. : <KBD>9107</KBD>
-</PRE>
-
-<P>This essentially makes the Axis print server look like a Hewlett Packard JetDirect EX print server. Save the file and then upload the new <VAR>config</VAR> file using the <TT>ftp</TT> command:</P>
-
-<PRE CLASS="command">
-<KBD>ftp ip-address</KBD>
-Connected to ip-address.
-220 Axis NPS ### FTP Printer Server V#.## MON DD YEAR ready.
-ftp> <KBD>user root</KBD>
-331 User name ok, need password
-Password: <KBD>pass</KBD> <I>(this is not echoed)</I>
-230 User logged in
-ftp> <KBD>put config CONFIG</KBD>
-local: config remote: CONFIG
-200 PORT command successful.
-150 Opening data connection for config (192,0,2,2), (mode ascii).
-226 Transfer complete.
-##### bytes received in #.## seconds (##### Kbytes/s)
-ftp> <KBD>get hardreset</KBD>
-local: hardreset remote: hardreset
-200 PORT command successful.
-421 Axis NPS ### hard reset, closing connection.
-ftp> <KBD>quit</KBD>
-221 Goodbye.
-</PRE>
-
-<P>Your Axis print server is now ready for use!</P>
-
-<H3><A NAME="LINKSYS">Configuring Linksys Print Servers</A></H3>
-
-<P>The Linksys print servers can be configured using BOOTP or DHCP. Like older Axis print servers, an additional step must be performed to configure the TCP/IP portion of the print server for use with CUPS.</P>
-
-<P>Each print server contains a configuration file named <VAR>CONFIG</VAR> that contains a list of network parameters used by the server. To modify this file you must first download it from the print server using the <TT>ftp(1)</TT> program:</P>
-
-<PRE CLASS="command">
-<KBD>ftp -n ip-address</KBD>
-Connected to ip-address.
-220 Print Server Ready.
-Remote system type is Print.
-ftp> <KBD>get CONFIG</KBD>
-local: CONFIG remote: CONFIG
-200 Command OK.
-150 Open ASCII Mode Connection.
-WARNING! 68 bare linefeeds received in ASCII mode
-File may not have transferred correctly.
-226 Transfer complete.
-##### bytes received in #.## seconds (##### Kbytes/s)
-ftp> <KBD>quit</KBD>
-221 Goodbye.
-</PRE>
-
-<P>Next, edit the file with your favorite text editor and locate the lines beginning with:</P>
-
-<PRE CLASS="command">
-0100 L1_PROUT:P1
-0120 L2_PROUT:P1
-0140 L3_PROUT:P1
-</PRE>
-
-<P>Change the port number for each parallel and serial port on the server as follows:</P>
-
-<PRE CLASS="command">
-0100 L1_PROUT:<KBD>P1</KBD>
-0120 L2_PROUT:<KBD>P2</KBD>
-0140 L3_PROUT:<KBD>P3</KBD>
-</PRE>
-
-<P>This maps each virtual printer with a physical port. Save the file and then upload the new <VAR>CONFIG</VAR> file using the <TT>ftp</TT> command:</P>
-
-<PRE CLASS="command">
-<KBD>ftp -n ip-address</KBD>
-Connected to ip-address.
-220 Print Server Ready.
-Remote system type is Print.
-ftp> <KBD>put CONFIG</KBD>
-local: CONFIG remote: CONFIG
-200 Command OK.
-150 Open ASCII Mode Connection.
-226 Transfer complete.
-##### bytes received in #.## seconds (##### Kbytes/s)
-ftp> <KBD>quit</KBD>
-221 Goodbye.
-</PRE>
-
-<P>Your Linksys print server is now ready for use!</P>
-
-</BODY>
-</HTML>
+ <p>Once you have collected the snmpwalk output, you should go to the <a href="https://github.com/apple/cups/issues">CUPS Issue Tracker</a> page to submit a feature request to support your printer or print server. Be sure to attach those two log files you created - they will help us to identify the SNMP values we need to look for.</p>
+ </body>
+</html>
projects / thirdparty / cups.git / blobdiff