]> git.ipfire.org Git - thirdparty/cups.git/blob - man/cups-snmp.man.in
Update .gitignore to ignore compressed man pages.
[thirdparty/cups.git] / man / cups-snmp.man.in
1 .\"
2 .\" SNMP backend man page for CUPS.
3 .\"
4 .\" Copyright © 2012-2018 by Apple Inc.
5 .\"
6 .\" Licensed under Apache License v2.0. See the file "LICENSE" for more
7 .\" information.
8 .\"
9 .TH cups-snmp 8 "CUPS" "8 November 2018" "Apple Inc."
10 .SH NAME
11 snmp \- cups snmp backend
12 .SH SYNOPSIS
13 .B /usr/lib/cups/backend/snmp
14 .I ip-address-or-hostname
15 .br
16 .B /usr/libexec/cups/backend/snmp
17 .I ip-address-or-hostname
18 .br
19 .B lpinfo
20 .B \-v
21 .B \-\-include-schemes
22 snmp
23 .SH DESCRIPTION
24 The \fBDEPRECATED\fR CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1.
25 When used for discovery through the scheduler, the backend will list all printers that respond to a broadcast SNMPv1 query with the "public" community name.
26 Additional 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.
27 .LP
28 In 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.
29 This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
30 .LP
31 In the second form, the SNMP backend is run indirectly using the
32 .BR lpinfo (8)
33 command.
34 The output provides all printers detected via SNMP on the configured
35 broadcast addresses.
36 \fINote: no broadcast addresses are configured by default.\fR
37 .SH ENVIRONMENT
38 The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable.
39 The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable.
40 .SH FILES
41 The SNMP backend reads the \fI/etc/cups/snmp.conf\fR configuration file, if
42 present, to set the default broadcast address, community name, and logging
43 level.
44 .SH NOTES
45 The CUPS SNMP backend is deprecated and will no longer be supported in a future
46 version of CUPS.
47 .SH CONFORMING TO
48 The 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.
49 .SH SEE ALSO
50 .BR backend (7),
51 .BR cups-snmp.conf (5),
52 .BR cupsd (8),
53 .BR lpinfo (8),
54 CUPS Online Help (http://localhost:631/help)
55 .SH COPYRIGHT
56 Copyright \[co] 2007-2018 by Apple Inc.