]> git.ipfire.org Git - thirdparty/cups.git/blame - man/cups-snmp.conf.man
Import CUPS v2.0b1
[thirdparty/cups.git] / man / cups-snmp.conf.man
CommitLineData
89d46774 1.\"
1a18c85c 2.\" "$Id: cups-snmp.conf.man 11913 2014-06-10 19:00:24Z msweet $"
89d46774 3.\"
1a18c85c 4.\" snmp.conf man page for CUPS.
89d46774 5.\"
1a18c85c
MS
6.\" Copyright 2007-2014 by Apple Inc.
7.\" Copyright 2006 by Easy Software Products.
89d46774 8.\"
1a18c85c
MS
9.\" These coded instructions, statements, and computer programs are the
10.\" property of Apple Inc. and are protected by Federal copyright
11.\" law. Distribution and use rights are outlined in the file "LICENSE.txt"
12.\" which should have been included with this file. If this file is
13.\" file is missing or damaged, see the license at "http://www.cups.org/".
89d46774 14.\"
1a18c85c 15.TH snmp.conf 5 "CUPS" "10 June 2014" "Apple Inc."
89d46774 16.SH NAME
17snmp.conf \- snmp configuration file for cups
18.SH DESCRIPTION
1a18c85c
MS
19The
20.B snmp.conf
21file configures how the standard CUPS network backends (http, https, ipp, ipps, lpd, snmp, and socket) access printer information using SNMPv1 and is normally located in the \fI/etc/cups\fR directory.
22Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character.
89d46774 23.LP
1a18c85c
MS
24The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend -
25.BR cups-snmp (8).
89d46774 26.SH DIRECTIVES
1a18c85c 27The following directives are understood by the CUPS network backends:
89d46774 28.TP 5
1a18c85c 29\fBAddress @IF(\fIname\fB)\fR
89d46774 30.TP 5
1a18c85c 31\fBAddress @LOCAL\fR
89d46774 32.TP 5
1a18c85c
MS
33\fBAddress \fIaddress\fR
34Sends SNMP broadcast queries (for discovery) to the specified address(es).
35There is no default for the broadcast address.
89d46774 36.TP 5
1a18c85c
MS
37\fBCommunity \fIname\fR
38Specifies the community name to use.
39Only a single community name may be specified.
40The default community name is "public".
89d46774 41.TP 5
1a18c85c
MS
42\fBDebugLevel \fInumber\fR
43Specifies the logging level from 0 (none) to 3 (everything).
44Typically only used for debugging (thus the name).
45The default debug level is 0.
f3c17241 46.TP 5
1a18c85c
MS
47\fBDeviceURI "\fIregular expression\fB" \fIdevice-uri \fR[... \fIdevice-uri\fR]
48Specifies one or more device URIs that should be used for a given make and model string.
49The regular expression is used to match the detected make and model, and the device URI strings must be of the form "scheme://%s[:port]/[path]", where "%s" represents the detected address or hostname.
50There are no default device URI matching rules.
89d46774 51.TP 5
1a18c85c 52\fBHostNameLookups on\fR
89d46774 53.TP 5
1a18c85c
MS
54\fBHostNameLookups off\fR
55Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses.
56The default is "off".
d09495fa 57.TP 5
1a18c85c 58\fBMaxRunTime \fIseconds\fR
f3c17241 59Specifies the maximum number of seconds that the SNMP backend will scan the
1a18c85c
MS
60network for printers.
61The default is 120 seconds (2 minutes).
89d46774 62.SH SEE ALSO
1a18c85c
MS
63.BR cups-snmp (8),
64CUPS Online Help (http://localhost:631/help)
89d46774 65.SH COPYRIGHT
1a18c85c 66Copyright \[co] 2007-2014 by Apple Inc.
89d46774 67.\"
1a18c85c 68.\" End of "$Id: cups-snmp.conf.man 11913 2014-06-10 19:00:24Z msweet $".
89d46774 69.\"