]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cups-snmp.man.in
Merge pull request #5112 from paulmenzel/remove-libgcrypt-detection
[thirdparty/cups.git] / man / cups-snmp.man.in
CommitLineData
f3c17241 1.\"
ce0ddeb2 2.\" SNMP backend man page for CUPS.
f3c17241 3.\"
ce0ddeb2 4.\" Copyright 2012-2014 by Apple Inc.
f3c17241 5.\"
ce0ddeb2
MS
6.\" These coded instructions, statements, and computer programs are the
7.\" property of Apple Inc. and are protected by Federal copyright
8.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
9.\" which should have been included with this file. If this file is
10.\" file is missing or damaged, see the license at "http://www.cups.org/".
f3c17241 11.\"
ce0ddeb2 12.TH cups-snmp 8 "CUPS" "10 June 2014" "Apple Inc."
f3c17241
MS
13.SH NAME
14snmp \- cups snmp backend
15.SH SYNOPSIS
ffa2ca90
MS
16.B /usr/lib/cups/backend/snmp
17.I ip-address-or-hostname
18.br
19.B /usr/libexec/cups/backend/snmp
f3c17241
MS
20.I ip-address-or-hostname
21.br
ce0ddeb2
MS
22.B lpinfo
23.B \-v
24.B \-\-include-schemes
25snmp
f3c17241 26.SH DESCRIPTION
ce0ddeb2
MS
27The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1.
28When used for discovery through the scheduler, the backend will list all printers that respond to a broadcast SNMPv1 query with the "public" community name.
29Additional 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 30.LP
ce0ddeb2
MS
31In 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.
32This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
f3c17241 33.LP
ce0ddeb2
MS
34In the second form, the SNMP backend is run indirectly using the
35.BR lpinfo (8)
36command.
37The output provides all printers detected via SNMP on the configured
38broadcast addresses.
39\fINote: no broadcast addresses are configured by default.\fR
40.SH ENVIRONMENT
41The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable.
42The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable.
43.SH FILES
44The SNMP backend reads the \fI/etc/cups/snmp.conf\fR configuration file, if
f3c17241 45present, to set the default broadcast address, community name, and logging
ce0ddeb2
MS
46level.
47.SH CONFORMING TO
48The 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 49.SH SEE ALSO
ce0ddeb2
MS
50.BR backend (7),
51.BR cups-snmp.conf (5),
52.BR cupsd (8),
53.BR lpinfo (8),
54CUPS Online Help (http://localhost:631/help)
f3c17241 55.SH COPYRIGHT
bd5a2f28 56Copyright \[co] 2007-2017 by Apple Inc.