From ce0ddeb24499cb3435d3cdaced4d2a367fac0da7 Mon Sep 17 00:00:00 2001 From: msweet Date: Tue, 10 Jun 2014 19:00:24 +0000 Subject: [PATCH] More man page updates. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11913 a1ca3aef-8c08-0410-bb20-df032aa958be --- doc/help/man-cups-snmp.conf.html | 79 +++++++++++------------- doc/help/man-cups-snmp.html | 59 +++++++++--------- doc/help/man-cupsaccept.html | 89 +++++++++++++++----------- man/cups-snmp.conf.man | 95 +++++++++++++--------------- man/cups-snmp.man.in | 75 +++++++++++----------- man/cupsaccept.man | 103 ++++++++++++++++++------------- 6 files changed, 255 insertions(+), 245 deletions(-) diff --git a/doc/help/man-cups-snmp.conf.html b/doc/help/man-cups-snmp.conf.html index 6c78787044..fb8c88925f 100644 --- a/doc/help/man-cups-snmp.conf.html +++ b/doc/help/man-cups-snmp.conf.html @@ -7,58 +7,49 @@

snmp.conf(5)

Name

snmp.conf - snmp configuration file for cups

Description

-The 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 /etc/cups directory. Each line in -the file can be a configuration directive, a blank line, or a comment. Comment -lines start with the # character. -

The Community and DebugLevel directives are used by all backends. The remainder -apply only to the SNMP backend (cups-snmp(8)). +The +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 /etc/cups directory. +Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. +

The Community and DebugLevel directives are used by all backends. The remainder apply only to the SNMP backend - +cups-snmp(8).

Directives

-The following directives are understood by the CUPS network backends. Consult -the on-line help for detailed descriptions: +The following directives are understood by the CUPS network backends:

Address @IF(name) -
Address @LOCAL -
Address address -: -Sends SNMP broadcast queries to the specified address(es). There is no default -for the broadcast address. -
Community name -: -Specifies the community name to use. Only a single community name may be -specified. The default community name is "public". -
DebugLevel number -: -Specifies the logging level from 0 (none) to 3 (everything). Typically only used -for debugging (thus the name). The default debug level is 0. -
DeviceURI "regular expression" device-uri [... device-uri] -: -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. -
HostNameLookups on -
HostNameLookups off -: -Specifies whether the addresses of printers should be converted to hostnames or -left as numeric IP addresses. The default is "off". -
MaxRunTime seconds -: -Specifies the maximum number of seconds that the SNMP backend will scan the -network for printers. The default is 120 seconds (2 minutes). +
Address @IF(name) +
Address @LOCAL +
Address address +: Sends SNMP broadcast queries (for discovery) to the specified address(es). +There is no default for the broadcast address. +
Community name +: Specifies the community name to use. +Only a single community name may be specified. +The default community name is "public". +
DebugLevel number +: Specifies the logging level from 0 (none) to 3 (everything). +Typically only used for debugging (thus the name). +The default debug level is 0. +
DeviceURI "regular expression" device-uri [... device-uri] +: 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. +
HostNameLookups on +
HostNameLookups off +: Specifies whether the addresses of printers should be converted to hostnames or left as numeric IP addresses. +The default is "off". +
MaxRunTime seconds +: Specifies the maximum number of seconds that the SNMP backend will scan the +network for printers. +The default is 120 seconds (2 minutes).

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-cups-snmp.html b/doc/help/man-cups-snmp.html index 7d3aeedfa8..06a48133ff 100644 --- a/doc/help/man-cups-snmp.html +++ b/doc/help/man-cups-snmp.html @@ -16,40 +16,39 @@ snmp - cups snmp backend /usr/libexec/cups/backend/snmp ip-address-or-hostname
-lpinfo-v--include-schemessnmp +lpinfo +-v +--include-schemes +snmp

Description

-The CUPS SNMP backend provides legacy discovery and identification of network -printers using SNMPv1. 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. 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. -

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. This -can be used for programs that need to configure print queues where the user has -supplied an address but nothing else. -

In the second form, the SNMP backend is run indirectly using the lpinfo(8) -command. The output provides all printers detected via SNMP on the configured -broadcast addresses. Note: no broadcast addresses are configured by -default. -

Mibs

-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. -

Configuration

-The SNMP backend reads the /etc/cups/snmp.conf configuration file, if +The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1. +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. +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. +

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. +This can be used for programs that need to configure print queues where the user has supplied an address but nothing else. +

In the second form, the SNMP backend is run indirectly using the +lpinfo(8) +command. +The output provides all printers detected via SNMP on the configured +broadcast addresses. +Note: no broadcast addresses are configured by default. +

Environment

+The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable. +The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable. +

Files

+The SNMP backend reads the /etc/cups/snmp.conf configuration file, if present, to set the default broadcast address, community name, and logging -level. The configuration file is documented in cups-snmp.conf(5). The -DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment -variable and the MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME -environment variable. +level. +

Conforming To

+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.

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-cupsaccept.html b/doc/help/man-cupsaccept.html index 8145e09d4d..739d615f00 100644 --- a/doc/help/man-cupsaccept.html +++ b/doc/help/man-cupsaccept.html @@ -11,59 +11,74 @@ cupsaccept/cupsreject - accept/reject jobs sent to a destination

Synopsis

cupsaccept -[ -E ] [ -U +[ +-E +] [ +-U username -] [ -h +] [ +-h hostname[:port] -] destination(s) +] +destination(s)
cupsreject -[ -E ] [ -U +[ +-E +] [ +-U username -] [ -h +] [ +-h hostname[:port] -] [ -r +] [ +-r reason -] destination(s) +] +destination(s)

Description

-cupsaccept instructs the printing system to accept print jobs to the +The +cupsaccept +command instructs the printing system to accept print jobs to the specified destinations. +

The +cupsreject +command instructs the printing system to reject print jobs to the specified destinations. -

cupsreject instructs the printing system to reject print jobs to the -specified destinations. The -r option sets the reason for rejecting -print jobs. If not specified the reason defaults to "Reason Unknown". +The -r option sets the reason for rejecting print jobs. If not specified, the reason defaults to "Reason Unknown".

Options

-The following options are supported by both cupsaccept and -cupsreject: +The following options are supported by both +cupsaccept +and +cupsreject:

-E -: -Forces encryption when connecting to the server. -
-U username -: -Sets the username that is sent when connecting to the server. -
-h hostname[:port] -: -Chooses an alternate server. -
-r "reason" -: -Sets the reason string that is shown for a printer that is -rejecting jobs. +
-E +: Forces encryption when connecting to the server. +
-U username +: Sets the username that is sent when connecting to the server. +
-h hostname[:port] +: Chooses an alternate server. +
-r "reason" +: Sets the reason string that is shown for a printer that is rejecting jobs.

Compatibility

-Unlike the System V printing system, CUPS allows printer names to -contain any printable character except SPACE, TAB, "/", or "#". +

Conforming To

+The +cupsaccept +and +cupsreject +commands correspond to the System V printing system commands "accept" and "reject", respectively. +Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#". Also, printer and class names are not case-sensitive. -

The CUPS versions of accept and reject may ask the -user for an access password depending on the printing system -configuration. This differs from the System V versions which -require the root user to execute these commands. +

Finally, the CUPS versions may ask the user for an access password depending on the printing system configuration.

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/man/cups-snmp.conf.man b/man/cups-snmp.conf.man index 3e8bc78a4b..febb498c78 100644 --- a/man/cups-snmp.conf.man +++ b/man/cups-snmp.conf.man @@ -1,78 +1,69 @@ .\" .\" "$Id$" .\" -.\" snmp.conf man page for CUPS. +.\" snmp.conf man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 2006 by Easy Software Products. +.\" 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/". +.\" 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." - +.TH snmp.conf 5 "CUPS" "10 June 2014" "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. +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 (\fIcups-snmp(8)\fR). +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. Consult -the on-line help for detailed descriptions: +The following directives are understood by the CUPS network backends: .TP 5 -Address @IF(\fIname\fR) +\fBAddress @IF(\fIname\fB)\fR .TP 5 -Address @LOCAL +\fBAddress @LOCAL\fR .TP 5 -Address \fIaddress\fR -.br -Sends SNMP broadcast queries to the specified address(es). There is no default -for the broadcast address. +\fBAddress \fIaddress\fR +Sends SNMP broadcast queries (for discovery) 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". +\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 -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. +\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 -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. +\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 -HostNameLookups on +\fBHostNameLookups on\fR .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". +\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 -MaxRunTime \fIseconds\fR -.br +\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). +network for printers. +The default is 120 seconds (2 minutes). .SH SEE ALSO -cups-snmp(8), -.br -http://localhost:631/help +.BR cups-snmp (8), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\" diff --git a/man/cups-snmp.man.in b/man/cups-snmp.man.in index ae07f248db..ce9c713ca8 100644 --- a/man/cups-snmp.man.in +++ b/man/cups-snmp.man.in @@ -1,17 +1,17 @@ .\" .\" "$Id$" .\" -.\" SNMP backend man page for CUPS. +.\" SNMP backend man page for CUPS. .\" -.\" Copyright 2012-2013 by Apple Inc. +.\" Copyright 2012-2014 by Apple Inc. .\" -.\" 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/". +.\" 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 cups-snmp 8 "CUPS" "8 July 2013" "Apple Inc." +.TH cups-snmp 8 "CUPS" "10 June 2014" "Apple Inc." .SH NAME snmp \- cups snmp backend .SH SYNOPSIS @@ -21,42 +21,41 @@ snmp \- cups snmp backend .B /usr/libexec/cups/backend/snmp .I ip-address-or-hostname .br -.B lpinfo -v --include-schemes snmp +.B lpinfo +.B \-v +.B \-\-include-schemes +snmp .SH DESCRIPTION -The CUPS SNMP backend provides legacy discovery and identification of network -printers using SNMPv1. 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. 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. +The CUPS SNMP backend provides legacy discovery and identification of network printers using SNMPv1. +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. +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. .LP -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. This -can be used for programs that need to configure print queues where the user has -supplied an address but nothing else. +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. +This can be used for programs that need to configure print queues where the user has supplied an address but nothing else. .LP -In the second form, the SNMP backend is run indirectly using the \fIlpinfo(8)\fR -command. The output provides all printers detected via SNMP on the configured -broadcast addresses. \fBNote\fR: no broadcast addresses are configured by -default. -.SH MIBS -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. -.SH CONFIGURATION -The SNMP backend reads the /etc/cups/snmp.conf configuration file, if +In the second form, the SNMP backend is run indirectly using the +.BR lpinfo (8) +command. +The output provides all printers detected via SNMP on the configured +broadcast addresses. +\fINote: no broadcast addresses are configured by default.\fR +.SH ENVIRONMENT +The DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment variable. +The MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME environment variable. +.SH FILES +The SNMP backend reads the \fI/etc/cups/snmp.conf\fR configuration file, if present, to set the default broadcast address, community name, and logging -level. The configuration file is documented in \fIcups-snmp.conf(5)\fR. The -DebugLevel value can be overridden using the CUPS_DEBUG_LEVEL environment -variable and the MaxRunTime value can be overridden using the CUPS_MAX_RUN_TIME -environment variable. +level. +.SH CONFORMING TO +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. .SH SEE ALSO -\fIbackend(7)\fR, \fIcups-snmp.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, -\fIfilter(7)\fR, \fIlpinfo(8)\fR, -.br -http://localhost:631/help +.BR backend (7), +.BR cups-snmp.conf (5), +.BR cupsd (8), +.BR lpinfo (8), +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\" diff --git a/man/cupsaccept.man b/man/cupsaccept.man index 5a852a214e..d7d0e36a3a 100644 --- a/man/cupsaccept.man +++ b/man/cupsaccept.man @@ -1,79 +1,94 @@ .\" .\" "$Id$" .\" -.\" accept/reject man page for CUPS. +.\" accept/reject man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 1997-2006 by Easy Software Products. +.\" Copyright 2007-2014 by Apple Inc. +.\" Copyright 1997-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/". +.\" 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 cupsaccept 8 "CUPS" "12 February 2006" "Apple Inc." +.TH cupsaccept 8 "CUPS" "10 June 2014" "Apple Inc." .SH NAME cupsaccept/cupsreject \- accept/reject jobs sent to a destination .SH SYNOPSIS .B cupsaccept -[ -E ] [ -U +[ +.B \-E +] [ +.B \-U .I username -] [ -h +] [ +.B \-h .I hostname[:port] -] destination(s) +] +.I destination(s) .br .B cupsreject -[ -E ] [ -U +[ +.B \-E +] [ +.B \-U .I username -] [ -h +] [ +.B \-h .I hostname[:port] -] [ -r +] [ +.B \-r .I reason -] destination(s) +] +.I destination(s) .SH DESCRIPTION -\fIcupsaccept\fR instructs the printing system to accept print jobs to the -specified destinations. +The +.B cupsaccept +command instructs the printing system to accept print jobs to the specified destinations. .LP -\fIcupsreject\fR instructs the printing system to reject print jobs to the -specified destinations. The \fI-r\fR option sets the reason for rejecting -print jobs. If not specified the reason defaults to "Reason Unknown". +The +.B cupsreject +command instructs the printing system to reject print jobs to the +specified destinations. +The \fI-r\fR option sets the reason for rejecting print jobs. If not specified, the reason defaults to "Reason Unknown". .SH OPTIONS -The following options are supported by both \fIcupsaccept\fR and -\fIcupsreject\fR: +The following options are supported by both +.B cupsaccept +and +.BR cupsreject : .TP 5 --E -.br +.B \-E Forces encryption when connecting to the server. .TP 5 --U username -.br +\fB-U \fIusername\fR Sets the username that is sent when connecting to the server. .TP 5 --h hostname[:port] -.br +\fB-h \fIhostname[:port]\fR Chooses an alternate server. .TP 5 --r "reason" -.br -Sets the reason string that is shown for a printer that is -rejecting jobs. -.SH COMPATIBILITY -Unlike the System V printing system, CUPS allows printer names to -contain any printable character except SPACE, TAB, "/", or "#". +\fB-r \fR"\fIreason\fR" +Sets the reason string that is shown for a printer that is rejecting jobs. +.SH CONFORMING TO +The +.B cupsaccept +and +.B cupsreject +commands correspond to the System V printing system commands "accept" and "reject", respectively. +Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", or "#". Also, printer and class names are \fInot\fR case-sensitive. .LP -The CUPS versions of \fIaccept\fR and \fIreject\fR may ask the -user for an access password depending on the printing system -configuration. This differs from the System V versions which -require the root user to execute these commands. +Finally, the CUPS versions may ask the user for an access password depending on the printing system configuration. .SH SEE ALSO -\fIcancel(1)\fR, \fIcupsenable(8)\fR, \fIlp(1)\fR, -\fIlpadmin(8)\fR, \fIlpstat(1)\fR, +.BR cancel (1), +.BR cupsenable (8), +.BR lp (1), +.BR lpadmin (8), +.BR lpstat (1), .br -http://localhost:631/help +CUPS Online Help (http://localhost:631/help) .SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. +Copyright \[co] 2007-2014 by Apple Inc. .\" .\" End of "$Id$". .\" -- 2.47.2

snmp.conf(5)

Name

Description

Directives

See Also

Copyright

Description

Mibs

Configuration

Environment

Files

Conforming To

See Also

Copyright

Synopsis

Description

Options

Compatibility

Conforming To

See Also

Copyright