]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cups-snmp.man.in
Update copyright to 2013.
[thirdparty/cups.git] / man / cups-snmp.man.in
CommitLineData
c45401bb 1.\"
2.\" "$Id$"
3.\"
4.\" SNMP backend man page for CUPS.
5.\"
dc0f86cb 6.\" Copyright 2012-2013 by Apple Inc.
c45401bb 7.\"
8.\" These coded instructions, statements, and computer programs are the
9.\" property of Apple Inc. and are protected by Federal copyright
10.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
11.\" which should have been included with this file. If this file is
12.\" file is missing or damaged, see the license at "http://www.cups.org/".
13.\"
14.TH cups-snmp 8 "CUPS" "23 April 2012" "Apple Inc."
15.SH NAME
16snmp \- cups snmp backend
17.SH SYNOPSIS
18.B @CUPS_SERVERBIN@/backend/snmp
19.I ip-address-or-hostname
20.br
21.B lpinfo -v --include-schemes snmp
22.SH DESCRIPTION
23The CUPS SNMP backend provides legacy discovery and identification of network
24printers using SNMPv1. When used for discovery through the scheduler, the
25backend will list all printers that respond to a broadcast SNMPv1 query with the
26"public" community name. Additional queries are then sent to printers that
27respond in order to determine the correct device URI, make and model, and other
28information needed for printing.
29.LP
30In the first form, the SNMP backend is run directly by the user to look up the
31device URI and other information when you have an IP address or hostname. This
32can be used for programs that need to configure print queues where the user has
33supplied an address but nothing else.
34.LP
35In the second form, the SNMP backend is run indirectly using the \fIlpinfo(8)\fR
36command. The output provides all printers detected via SNMP on the configured
37broadcast addresses. \fBNote\fR: no broadcast addresses are configured by
38default.
39.SH MIBS
40The CUPS SNMP backend uses the information from the Host, Printer, and Port
41Monitor MIBs along with some vendor private MIBs and intelligent port probes to
42determine the correct device URI and make and model for each printer.
43.SH CONFIGURATION
44The SNMP backend reads the @CUPS_SERVERROOT@/snmp.conf configuration file, if
45present, to set the default broadcast address, community name, and logging
46level. The configuration file is documented in \fIcups-snmp.conf(5)\fR. The
47DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment
48variable and the MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME
49environment variable.
50.SH SEE ALSO
51\fIbackend(7)\fR, \fIcups-snmp.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR,
52\fIfilter(7)\fR, \fIlpinfo(8)\fR,
53.br
54http://localhost:631/help
55.SH COPYRIGHT
dc0f86cb 56Copyright 2007-2013 by Apple Inc.
c45401bb 57.\"
58.\" End of "$Id$".
59.\"