man/cups-snmp.man.in

   1 .\"
   2 .\" "$Id$"
   3 .\"
   4 .\" SNMP backend man page for CUPS.
   5 .\"
   6 .\" Copyright 2012-2014 by Apple Inc.
   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" "10 June 2014" "Apple Inc."
  15 .SH NAME
  16 snmp \- cups snmp backend
  17 .SH SYNOPSIS
  18 .B /usr/lib/cups/backend/snmp
  19 .I ip-address-or-hostname
  20 .br
  21 .B /usr/libexec/cups/backend/snmp
  22 .I ip-address-or-hostname
  23 .br
  24 .B lpinfo
  25 .B \-v
  26 .B \-\-include-schemes
  27 snmp
  28 .SH DESCRIPTION
  29 The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1.
  30 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.
  31 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.
  32 .LP
  33 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.
  34 This can be used for programs that need to configure print queues where the user has supplied an address but nothing else.
  35 .LP
  36 In the second form, the SNMP backend is run indirectly using the
  37 .BR lpinfo (8)
  38 command.
  39 The output provides all printers detected via SNMP on the configured
  40 broadcast addresses.
  41 \fINote: no broadcast addresses are configured by default.\fR
  42 .SH ENVIRONMENT
  43 The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable.
  44 The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable.
  45 .SH FILES
  46 The SNMP backend reads the \fI/etc/cups/snmp.conf\fR configuration file, if
  47 present, to set the default broadcast address, community name, and logging
  48 level.
  49 .SH CONFORMING TO
  50 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.
  51 .SH SEE ALSO
  52 .BR backend (7),
  53 .BR cups-snmp.conf (5),
  54 .BR cupsd (8),
  55 .BR lpinfo (8),
  56 CUPS Online Help (http://localhost:631/help)
  57 .SH COPYRIGHT
  58 Copyright \[co] 2007-2015 by Apple Inc.
  59 .\"
  60 .\" End of "$Id$".
  61 .\"