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

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