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