man/cups-snmp.man.in

   1 .\"
   2 .\" SNMP backend man page for CUPS.
   3 .\"
   4 .\" Copyright 2012-2014 by Apple Inc.
   5 .\"
   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/".
  11 .\"
  12 .TH cups-snmp 8 "CUPS" "10 June 2014" "Apple Inc."
  13 .SH NAME
  14 snmp \- cups snmp backend
  15 .SH SYNOPSIS
  16 .B /usr/lib/cups/backend/snmp
  17 .I ip-address-or-hostname
  18 .br
  19 .B /usr/libexec/cups/backend/snmp
  20 .I ip-address-or-hostname
  21 .br
  22 .B lpinfo
  23 .B \-v
  24 .B \-\-include-schemes
  25 snmp
  26 .SH DESCRIPTION
  27 The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1.
  28 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.
  29 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.
  30 .LP
  31 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.
  32 This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
  33 .LP
  34 In the second form, the SNMP backend is run indirectly using the
  35 .BR lpinfo (8)
  36 command.
  37 The output provides all printers detected via SNMP on the configured
  38 broadcast addresses.
  39 \fINote: no broadcast addresses are configured by default.\fR
  40 .SH ENVIRONMENT
  41 The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable.
  42 The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable.
  43 .SH FILES
  44 The SNMP backend reads the \fI/etc/cups/snmp.conf\fR configuration file, if
  45 present, to set the default broadcast address, community name, and logging
  46 level.
  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-2016 by Apple Inc.