[thirdparty/cups.git] / man / cups-snmp.conf.man

.\"
.\" "$Id$"
.\"
.\"   snmp.conf man page for CUPS.
.\"
.\"   Copyright 2007-2013 by Apple Inc.
.\"   Copyright 2006 by Easy Software Products.
.\"
.\"   These coded instructions, statements, and computer programs are the
.\"   property of Apple Inc. and are protected by Federal copyright
.\"   law.  Distribution and use rights are outlined in the file "LICENSE.txt"
.\"   which should have been included with this file.  If this file is
.\"   file is missing or damaged, see the license at "http://www.cups.org/".
.\"
.TH snmp.conf 5 "CUPS" "23 April 2012" "Apple Inc."

.SH NAME
snmp.conf \- snmp configuration file for cups
.SH DESCRIPTION
The \fIsnmp.conf\fR file 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. Each line in
the file can be a configuration directive, a blank line, or a comment. Comment
lines start with the # character.
.LP
The Community and DebugLevel directives are used by all backends. The remainder
apply only to the SNMP backend (\fIcups-snmp(8)\fR).
.SH DIRECTIVES
The following directives are understood by the CUPS network backends. Consult
the on-line help for detailed descriptions:
.TP 5
Address @IF(\fIname\fR)
.TP 5
Address @LOCAL
.TP 5
Address \fIaddress\fR
.br
Sends SNMP broadcast queries to the specified address(es). There is no default
for the broadcast address.
.TP 5
Community \fIname\fR
.br
Specifies the community name to use. Only a single community name may be
specified. The default community name is "public".
.TP 5
DebugLevel number
.br
Specifies the logging level from 0 (none) to 3 (everything). Typically only used
for debugging (thus the name). The default debug level is 0.
.TP 5
DeviceURI "regular expression" device-uri [... device-uri]
.br
Specifies one or more device URIs that should be used for a given make and model
string. The 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. There are no default device
URI matching rules.
.TP 5
HostNameLookups on
.TP 5
HostNameLookups off
.br
Specifies whether the addresses of printers should be converted to hostnames or
left as numeric IP addresses. The default is "off".
.TP 5
MaxRunTime \fIseconds\fR
.br
Specifies the maximum number of seconds that the SNMP backend will scan the
network for printers. The default is 120 seconds (2 minutes).
.SH SEE ALSO
cups-snmp(8),
.br
http://localhost:631/help
.SH COPYRIGHT
Copyright 2007-2013 by Apple Inc.
.\"
.\" End of "$Id$".
.\"
Commit	Line	Data
	1	.\"
	2	.\" "$Id$"
	3	.\"
	4	.\" snmp.conf man page for CUPS.
	5	.\"
	6	.\" Copyright 2007-2013 by Apple Inc.
	7	.\" Copyright 2006 by Easy Software Products.
	8	.\"
	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/".
	14	.\"
	15	.TH snmp.conf 5 "CUPS" "23 April 2012" "Apple Inc."
	16
	17	.SH NAME
	18	snmp.conf \- snmp configuration file for cups
	19	.SH DESCRIPTION
	20	The \fIsnmp.conf\fR file configures how the standard CUPS network backends
	21	(http, https, ipp, ipps, lpd, snmp, and socket) access printer information using
	22	SNMPv1 and is normally located in the \fI/etc/cups\fR directory. Each line in
	23	the file can be a configuration directive, a blank line, or a comment. Comment
	24	lines start with the # character.
	25	.LP
	26	The Community and DebugLevel directives are used by all backends. The remainder
	27	apply only to the SNMP backend (\fIcups-snmp(8)\fR).
	28	.SH DIRECTIVES
	29	The following directives are understood by the CUPS network backends. Consult
	30	the on-line help for detailed descriptions:
	31	.TP 5
	32	Address @IF(\fIname\fR)
	33	.TP 5
	34	Address @LOCAL
	35	.TP 5
	36	Address \fIaddress\fR
	37	.br
	38	Sends SNMP broadcast queries to the specified address(es). There is no default
	39	for the broadcast address.
	40	.TP 5
	41	Community \fIname\fR
	42	.br
	43	Specifies the community name to use. Only a single community name may be
	44	specified. The default community name is "public".
	45	.TP 5
	46	DebugLevel number
	47	.br
	48	Specifies the logging level from 0 (none) to 3 (everything). Typically only used
	49	for debugging (thus the name). The default debug level is 0.
	50	.TP 5
	51	DeviceURI "regular expression" device-uri [... device-uri]
	52	.br
	53	Specifies one or more device URIs that should be used for a given make and model
	54	string. The regular expression is used to match the detected make and model, and
	55	the device URI strings must be of the form "scheme://%s[:port]/[path]", where
	56	"%s" represents the detected address or hostname. There are no default device
	57	URI matching rules.
	58	.TP 5
	59	HostNameLookups on
	60	.TP 5
	61	HostNameLookups off
	62	.br
	63	Specifies whether the addresses of printers should be converted to hostnames or
	64	left as numeric IP addresses. The default is "off".
	65	.TP 5
	66	MaxRunTime \fIseconds\fR
	67	.br
	68	Specifies the maximum number of seconds that the SNMP backend will scan the
	69	network for printers. The default is 120 seconds (2 minutes).
	70	.SH SEE ALSO
	71	cups-snmp(8),
	72	.br
	73	http://localhost:631/help
	74	.SH COPYRIGHT
	75	Copyright 2007-2013 by Apple Inc.
	76	.\"
	77	.\" End of "$Id$".
	78	.\"