.\"
-.\" "$Id$"
+.\" snmp.conf man page for CUPS.
.\"
-.\" snmp.conf man page for the Common UNIX Printing System (CUPS).
+.\" Copyright 2007-2014 by Apple Inc.
+.\" Copyright 2006 by Easy Software Products.
.\"
-.\" Copyright 2006 by Easy Software Products.
+.\" Licensed under Apache License v2.0. See the file "LICENSE" for more information.
.\"
-.\" These coded instructions, statements, and computer programs are the
-.\" property of Easy Software Products 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 missing or damaged please contact Easy Software Products
-.\" at:
-.\"
-.\" Attn: CUPS Licensing Information
-.\" Easy Software Products
-.\" 44141 Airport View Drive, Suite 204
-.\" Hollywood, Maryland 20636 USA
-.\"
-.\" Voice: (301) 373-9600
-.\" EMail: cups-info@cups.org
-.\" WWW: http://www.cups.org
-.\"
-.TH snmp.conf 5 "Common UNIX Printing System" "18 April 2006" "Easy Software Products"
+.TH snmp.conf 5 "CUPS" "10 June 2014" "Apple Inc."
.SH NAME
snmp.conf \- snmp configuration file for cups
.SH DESCRIPTION
-The \fIsnmp.conf\fR file configures the CUPS SNMP printer
-discovery backend and is normally located in the \fI/etc/cups\fR
-directory. Each line in the file can be a configuration
-directive, a blank line, or a comment. Comment lines start with
-the # character.
+The
+.B snmp.conf
+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 \fI/etc/cups\fR directory.
+Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
.LP
-The SNMP backend uses the SNMPv1 protocol to discover network
-printers, collecting information from the Host MIB along with
-intelligent port probes to determine the correct device URI and
-make and model for each printer. Future versions of CUPS will
-likely support the new Port Monitor MIB as well.
+The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
+.BR cups-snmp (8).
.SH DIRECTIVES
-The following directives are understood by the SNMP backend.
-Consult the on-line help for detailed descriptions:
+The following directives are understood by the CUPS network backends:
+.TP 5
+\fBAddress @IF(\fIname\fB)\fR
.TP 5
-Address @IF(\fIname\fR)
+\fBAddress @LOCAL\fR
.TP 5
-Address @LOCAL
+\fBAddress \fIaddress\fR
+Sends SNMP broadcast queries (for discovery) to the specified address(es).
+There is no default for the broadcast address.
.TP 5
-Address \fIaddress\fR
-.br
-Sends SNMP broadcast queries to the specified address(es). The
-default address is "@LOCAL" which broadcasts to all LAN
-interfaces.
+\fBCommunity \fIname\fR
+Specifies the community name to use.
+Only a single community name may be specified.
+The default community name is "public".
.TP 5
-Community \fIname\fR
-.br
-Specifies a SNMP community to query. The default community is
-"public".
+\fBDebugLevel \fInumber\fR
+Specifies the logging level from 0 (none) to 3 (everything).
+Typically only used for debugging (thus the name).
+The default debug level is 0.
.TP 5
-DebugLevel \fIN\fR
-.br
-Sets the debug logging level to \fIN\fR; 0 disables debug
-logging, 1 enables basic logging, 2 displays SNMP values, and 3
-displays raw hex data.
+\fBDeviceURI "\fIregular expression\fB" \fIdevice-uri \fR[... \fIdevice-uri\fR]
+Specifies one or more device URIs that should be used for a given make and model string.
+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.
+There are no default device URI matching rules.
.TP 5
-HostNameLookups on
+\fBHostNameLookups on\fR
.TP 5
-HostNameLookups off
-.br
-Specifies whether the addresses of printers should be converted
-to hostnames or left as numeric IP addresses. The default is
-"off".
+\fBHostNameLookups off\fR
+Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses.
+The default is "off".
+.TP 5
+\fBMaxRunTime \fIseconds\fR
+Specifies the maximum number of seconds that the SNMP backend will scan the
+network for printers.
+The default is 120 seconds (2 minutes).
.SH SEE ALSO
-http://localhost:631/help
+.BR cups-snmp (8),
+CUPS Online Help (http://localhost:631/help)
.SH COPYRIGHT
-Copyright 2006 by Easy Software Products, All Rights Reserved.
-.\"
-.\" End of "$Id$".
-.\"
+Copyright \[co] 2007-2017 by Apple Inc.
projects / thirdparty / cups.git / blobdiff