]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cups-snmp.man.in
Import CUPS v2.0b1
[thirdparty/cups.git] / man / cups-snmp.man.in
CommitLineData
f3c17241 1.\"
1a18c85c 2.\" "$Id: cups-snmp.man.in 11913 2014-06-10 19:00:24Z msweet $"
f3c17241 3.\"
1a18c85c 4.\" SNMP backend man page for CUPS.
f3c17241 5.\"
1a18c85c 6.\" Copyright 2012-2014 by Apple Inc.
f3c17241 7.\"
1a18c85c
MS
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/".
f3c17241 13.\"
1a18c85c 14.TH cups-snmp 8 "CUPS" "10 June 2014" "Apple Inc."
f3c17241
MS
15.SH NAME
16snmp \- cups snmp backend
17.SH SYNOPSIS
ffa2ca90
MS
18.B /usr/lib/cups/backend/snmp
19.I ip-address-or-hostname
20.br
21.B /usr/libexec/cups/backend/snmp
f3c17241
MS
22.I ip-address-or-hostname
23.br
1a18c85c
MS
24.B lpinfo
25.B \-v
26.B \-\-include-schemes
27snmp
f3c17241 28.SH DESCRIPTION
1a18c85c
MS
29The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1.
30When used for discovery through the scheduler, the backend will list all printers that respond to a broadcast SNMPv1 query with the "public" community name.
31Additional queries are then sent to printers that respond in order to determine the correct device URI, make and model, and other information needed for printing.
f3c17241 32.LP
1a18c85c
MS
33In the first form, the SNMP backend is run directly by the user to look up the device URI and other information when you have an IP address or hostname.
34This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
f3c17241 35.LP
1a18c85c
MS
36In the second form, the SNMP backend is run indirectly using the
37.BR lpinfo (8)
38command.
39The output provides all printers detected via SNMP on the configured
40broadcast addresses.
41\fINote: no broadcast addresses are configured by default.\fR
42.SH ENVIRONMENT
43The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable.
44The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable.
45.SH FILES
46The SNMP backend reads the \fI/etc/cups/snmp.conf\fR configuration file, if
f3c17241 47present, to set the default broadcast address, community name, and logging
1a18c85c
MS
48level.
49.SH CONFORMING TO
50The CUPS SNMP backend uses the information from the Host, Printer, and Port Monitor MIBs along with some vendor private MIBs and intelligent port probes to determine the correct device URI and make and model for each printer.
f3c17241 51.SH SEE ALSO
1a18c85c
MS
52.BR backend (7),
53.BR cups-snmp.conf (5),
54.BR cupsd (8),
55.BR lpinfo (8),
56CUPS Online Help (http://localhost:631/help)
f3c17241 57.SH COPYRIGHT
1a18c85c 58Copyright \[co] 2007-2014 by Apple Inc.
f3c17241 59.\"
1a18c85c 60.\" End of "$Id: cups-snmp.man.in 11913 2014-06-10 19:00:24Z msweet $".
f3c17241 61.\"