Greatly simplify the man page handling.
[thirdparty/cups.git] / doc / help / man-cups-snmp.conf.html
2 <html>
3 <!-- SECTION: Man Pages -->
4 <head>
5         <link rel="stylesheet" type="text/css" href="../cups-printable.css">
6         <title>snmp.conf(5)</title>
7 </head>
8 <body>
9 <h1 class="title">snmp.conf(5)</h1>
10 <h2 class="title"><a name="NAME">Name</a></h2>
11 snmp.conf - snmp configuration file for cups (deprecated)
12 <h2 class="title"><a name="DESCRIPTION">Description</a></h2>
13 The
14 <b>snmp.conf</b>
15 file configures how the standard CUPS network backends (http, https, ipp, ipps, lpd, snmp, and socket) access printer information using SNMPv1 and is normally located in the <i>/etc/cups</i> directory.
16 Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
17 <p>The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
18 <b>cups-snmp</b>(8).
19 <h2 class="title"><a name="DIRECTIVES">Directives</a></h2>
20 The following directives are understood by the CUPS network backends:
21 <dl class="man">
22 <dt><b>Address @IF(</b><i>name</i><b>)</b>
23 <dd style="margin-left: 5.0em"><dt><b>Address @LOCAL</b>
24 <dd style="margin-left: 5.0em"><dt><b>Address </b><i>address</i>
25 <dd style="margin-left: 5.0em">Sends SNMP broadcast queries (for discovery) to the specified address(es).
26 There is no default for the broadcast address.
27 <dt><b>Community </b><i>name</i>
28 <dd style="margin-left: 5.0em">Specifies the community name to use.
29 Only a single community name may be specified.
30 The default community name is "public".
31 If no name is specified, all SNMP functions are disabled.
32 <dt><b>DebugLevel </b><i>number</i>
33 <dd style="margin-left: 5.0em">Specifies the logging level from 0 (none) to 3 (everything).
34 Typically only used for debugging (thus the name).
35 The default debug level is 0.
36 <dt><b>DeviceURI "</b><i>regular expression</i><b>" </b><i>device-uri </i>[... <i>device-uri</i>]
37 <dd style="margin-left: 5.0em">Specifies one or more device URIs that should be used for a given make and model string.
38 The regular expression is used to match the detected make and model, and the device URI strings must be of the form "scheme://%s[:port]/[path]", where "%s" represents the detected address or hostname.
39 There are no default device URI matching rules.
40 <dt><b>HostNameLookups on</b>
41 <dd style="margin-left: 5.0em"><dt><b>HostNameLookups off</b>
42 <dd style="margin-left: 5.0em">Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses.
43 The default is "off".
44 <dt><b>MaxRunTime </b><i>seconds</i>
45 <dd style="margin-left: 5.0em">Specifies the maximum number of seconds that the SNMP backend will scan the
46 network for printers.
47 The default is 120 seconds (2 minutes).
48 </dl>
49 <h2 class="title"><a name="NOTES">Notes</a></h2>
50 CUPS backends are deprecated and will no longer be supported in a future feature release of CUPS.
51 Printers that do not support IPP can be supported using applications such as
52 <b>ippeveprinter</b>(1).
53 <h2 class="title"><a name="SEE_ALSO">See Also</a></h2>
54 <b>cups-snmp</b>(8),
55 CUPS Online Help (<a href="http://localhost:631/help">http://localhost:631/help</a>)
56 <h2 class="title"><a name="COPYRIGHT">Copyright</a></h2>
57 Copyright &copy; 2007-2019 by Apple Inc.
59 </body>
60 </html>