From: msweet Date: Thu, 12 Jun 2014 19:10:33 +0000 (+0000) Subject: Save man page updates. X-Git-Tag: v2.2b1~608 X-Git-Url: http://git.ipfire.org/?p=thirdparty%2Fcups.git;a=commitdiff_plain;h=27e0d6f8ec2ca7a95ca8b9e846cab427923bbc70 Save man page updates. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11924 a1ca3aef-8c08-0410-bb20-df032aa958be --- diff --git a/doc/help/man-lpq.html b/doc/help/man-lpq.html index 2f219626e..8eecc512d 100644 --- a/doc/help/man-lpq.html +++ b/doc/help/man-lpq.html @@ -11,51 +11,51 @@ lpq - show printer queue status

Synopsis

lpq -[ -E ] [ -U +[ +-E +] [ +-U username -] [ -h -server[:port] -] [ -P -destination[/instance] -] [ -a ] [ -l ] [ -+interval +] [ +-h server[:port] +] [ +-P destination[/instance] +] [ +-a +] [ +-l +] [ ++interval ]

Description

-lpq shows the current print queue status on the named -printer. Jobs queued on the default destination will be shown if -no printer or class is specified on the command-line. -

The +interval option allows you to continuously report the -jobs in the queue until the queue is empty; the list of jobs is -shown once every interval seconds. +lpq shows the current print queue status on the named printer. +Jobs queued on the default destination will be shown if no printer or class is specified on the command-line. +

The +interval option allows you to continuously report the jobs in the queue until the queue is empty; the list of jobs is shown once every interval seconds.

Options

-lpq supports the following options: +lpq supports the following options:
-
-E -

-Forces encryption when connecting to the server. -
-P destination[/instance] -

-Specifies an alternate printer or class name. -
-U username -

-Specifies an alternate username. -
-a -

-Reports jobs on all printers. -
-h server[:port] -

-Specifies an alternate server. -
-l -

-Requests a more verbose (long) reporting format. +
-E +
Forces encryption when connecting to the server. +
-P destination[/instance] +
Specifies an alternate printer or class name. +
-U username +
Specifies an alternate username. +
-a +
Reports jobs on all printers. +
-h server[:port] +
Specifies an alternate server. +
-l +
Requests a more verbose (long) reporting format.

See Also

-cancel(1), lp(1), lpr(1), lprm(1), -lpstat(1), -
-http://localhost:631/help +cancel(1), +lp(1), +lpr(1), +lprm(1), +lpstat(1), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-lpstat.html b/doc/help/man-lpstat.html index 513d3c809..b394b0c1d 100644 --- a/doc/help/man-lpstat.html +++ b/doc/help/man-lpstat.html @@ -11,110 +11,119 @@ lpstat - print cups status information

Synopsis

lpstat -[ -E ] [ -H ] [ -U +[ +-E +] [ +-H +] [ +-U username -] [ -h -hostname[:port] -] [ -l ] [ -W +] [ +-h hostname[:port] +] [ +-l +] [ +-W which-jobs -] [ -a [ +] [ +-a +[ destination(s) -] ] [ -c [ +] ] [ +-c +[ class(es) -] ] [ -d ] [ -o [ +] ] [ +-d +] [ +-o +[ destination(s) -] ] [ -p [ +] ] [ +-p +[ printer(s) -] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [ +] ] [ +-r +] [ +-R +] [ +-s +] [ +-t +] [ +-u +[ user(s) -] ] [ -v [ +] ] [ +-v +[ printer(s) ] ]

Description

-lpstat displays status information about the current -classes, jobs, and printers. When run with no arguments, -lpstat will list jobs queued by the current user. +lpstat displays status information about the current classes, jobs, and printers. +When run with no arguments, lpstat will list active jobs queued by the current user.

Options

-The lpstat command supports the following options: +The lpstat command supports the following options:
-
-E -

-Forces encryption when connecting to the server. -
-H -

-Shows the server hostname and port. -
-R -

-Shows the ranking of print jobs. -
-U username -

-Specifies an alternate username. -
-W which-jobs -

-Specifies which jobs to show, completed or -not-completed (the default). This option must appear -before the -o option and/or any printer names, otherwise -the default (not-completed) value will be used in the request to -the scheduler. -
-a [printer(s)] -

-Shows the accepting state of printer queues. If no printers are -specified then all printers are listed. -
-c [class(es)] -

-Shows the printer classes and the printers that belong to them. +
-E +
Forces encryption when connecting to the server. +
-H +
Shows the server hostname and port. +
-R +
Shows the ranking of print jobs. +
-U username +
Specifies an alternate username. +
-W which-jobs +
Specifies which jobs to show, "completed" or "not-completed" (the default). +This option must appear before the -o option and/or any printer names, otherwise the default ("not-completed") value will be used in the request to the scheduler. +
-a [printer(s)] +
Shows the accepting state of printer queues. +If no printers are specified then all printers are listed. +
-c [class(es)] +
Shows the printer classes and the printers that belong to them. If no classes are specified then all classes are listed. -
-d -

-Shows the current default destination. -
-h server[:port] -

-Specifies an alternate server. -
-l -

-Shows a long listing of printers, classes, or jobs. -
-o [destination(s)] -

-Shows the jobs queue on the specified destinations. If no destinations are -specified all jobs are shown. -
-p [printer(s)] -

-Shows the printers and whether or not they are enabled for printing. If -no printers are specified then all printers are listed. -
-r -

-Shows whether the CUPS server is running. -
-s -

-Shows a status summary, including the default destination, a -list of classes and their member printers, and a list of printers and -their associated devices. This is equivalent to using the "-d", "-c", -and "-v" options. -
-t -

-Shows all status information. This is equivalent to using the "-r", -"-d", "-c", "-v", "-a", "-p", and "-o" options. -
-u [user(s)] -

-Shows a list of print jobs queued by the specified users. If no users -are specified, lists the jobs queued by the current user. -
-v [printer(s)] -

-Shows the printers and what device they are attached to. If no printers -are specified then all printers are listed. +
-d +
Shows the current default destination. +
-h server[:port] +
Specifies an alternate server. +
-l +
Shows a long listing of printers, classes, or jobs. +
-o [destination(s)] +
Shows the jobs queued on the specified destinations. +If no destinations are specified all jobs are shown. +
-p [printer(s)] +
Shows the printers and whether they are enabled for printing. +If no printers are specified then all printers are listed. +
-r +
Shows whether the CUPS server is running. +
-s +
Shows a status summary, including the default destination, a list of classes and their member printers, and a list of printers and their associated devices. +This is equivalent to using the -d, -c, and -v options. +
-t +
Shows all status information. +This is equivalent to using the -r, -d, -c, -v, -a, -p, and -o options. +
-u [user(s)] +
Shows a list of print jobs queued by the specified users. +If no users are specified, lists the jobs queued by the current user. +
-v [printer(s)] +
Shows the printers and what device they are attached to. +If no printers are specified then all printers are listed.
-

Compatibility

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

Conforming To

+Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#". Also, printer and class names are not case-sensitive. -

The "-h", "-E", "-U", and "-W" options are unique to CUPS. -

The Solaris "-f", "-P", and "-S" options are silently ignored. +

The -h, -E, -U, and -W options are unique to CUPS. +

The Solaris -f, -P, and -S options are silently ignored.

See Also

-cancel(1), lp(1), -
-http://localhost:631/help +cancel(1), +lp(1), +lpq(1), +lpr(1), +lprm(1), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-mailto.conf.html b/doc/help/man-mailto.conf.html index 93e1bee5f..966b3651b 100644 --- a/doc/help/man-mailto.conf.html +++ b/doc/help/man-mailto.conf.html @@ -10,41 +10,33 @@

Name

mailto.conf - configuration file for cups email notifier

Description

-The mailto.conf file defines the local mail server and -email notification preferences for CUPS. -

Each line in the file can be a configuration directive, a blank line, -or a comment. Comment lines start with the # character. -

Directives

+The mailto.conf file defines the local mail server and email notification preferences for CUPS. +

Each line in the file can be a configuration directive, a blank line, or a comment. +Configuration directives typically consist of a name and zero or more values separated by whitespace. +The configuration directive name and values are case-insensitive. +Comment lines start with the # character. +

Directives

-
Cc cc-address@domain.com -

-Specifies an additional recipient for all email notifications. -
From from-address@domain.com -

-Specifies the sender of email notifications. -
Sendmail sendmail command and options -

-Specifies the sendmail command to use when sending email -notifications. Only one Sendmail or SMTPServer line -may be present in the mailto.conf file. If multiple lines -are present, only the last one is used. -
SMTPServer servername -

-Specifies a SMTP server to send email notifications to. Only one -Sendmail or SMTPServer line may be present in the -mailto.conf file. If multiple lines are present, only the -last one is used. -
Subject subject-prefix -

-Specifies a prefix string for the subject line of an email notification. +
Cc cc-address@domain.com +
Specifies an additional recipient for all email notifications. +
From from-address@domain.com +
Specifies the sender of email notifications. +
Sendmail sendmail command and options +
Specifies the sendmail command to use when sending email notifications. +Only one Sendmail or SMTPServer line may be present in the mailto.conf file. +If multiple lines are present, only the last one is used. +
SMTPServer servername +
Specifies a SMTP server to send email notifications to. +Only one Sendmail or SMTPServer line may be present in the mailto.conf file. +If multiple lines are present, only the last one is used. +
Subject subject-prefix +
Specifies a prefix string for the subject line of an email notification.

See Also

-classes.conf(5), cupsd(8), cupsd.conf(5), -mime.convs(5), mime.types(5), printers.conf(5), -
-http://localhost:631/help +cupsd(8), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-mime.convs.html b/doc/help/man-mime.convs.html index 543764591..f1e045e5a 100644 --- a/doc/help/man-mime.convs.html +++ b/doc/help/man-mime.convs.html @@ -10,29 +10,46 @@

Name

mime.convs - mime type conversion file for cups

Description

-The mime.convs file defines the filters that are available -for converting files from one format to another. The standard -filters support text, PDF, PostScript, HP-GL/2, and many types of -image files. -

Additional filters can be added to the mime.convs file or -(preferably) to other files in the CUPS configuration directory. -

Each line in the mime.convs file is a comment, blank, or filter -line. Comment lines start with the # character. Filter lines specify -the source and destination MIME types along with a relative cost -associated with the filter and the filter to run: +The mime.convs file defines the filters that are available for converting files from one format to another. +The standard filters support text, PDF, PostScript, and many types of image files. +

Additional filters are specified in files with the extension .convs in the CUPS configuration directory. +

Each line in the mime.convs file is a comment, blank, or filter +line. +Comment lines start with the # character. +Filter lines specify the source and destination MIME types along with a relative cost associated with the filter and the filter to run: +

+
+    source/type destination/type cost filter
+
+
+The source/type field specifies the source MIME media type that is consumed by the filter. +

The destination/type field specifies the destiantion MIME media type that is produced by the filter. +

The cost field specifies the relative cost for running the filter. +A value of 100 means that the filter uses a large amount of resources while a value of 0 means that the filter uses very few resources. +

The filter field specifies the filter program filename. +Filenames are relative to the CUPS filter directory. +

Files

+/etc/cups - Typical CUPS configuration directory.
+/usr/lib/cups/filter - Typical CUPS filter directory. +
+/usr/libexec/cups/filter - CUPS filter directory on OS X. +

Examples

+Define a filter that converts PostScript documents to CUPS Raster format: 
 
-super/type super/type cost filter
-application/postscript application/vnd.cups-raster 50 pstoraster
+    application/vnd.cups-postscript application/vnd.cups-raster 50 pstoraster
+

See Also

-classes.conf(5), cupsd(8), cupsd.conf(5), -mime.types(5), printers.conf(5), -
-http://localhost:631/help +cups-files.conf(5), +cupsd.conf(5), +cupsd(8), +cupsfilter(8), +mime.types(5), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-mime.types.html b/doc/help/man-mime.types.html index 7772bd29f..89c8a498f 100644 --- a/doc/help/man-mime.types.html +++ b/doc/help/man-mime.types.html @@ -10,87 +10,88 @@

Name

mime.types - mime type description file for cups

Description

-The mime.types file defines the recognized file types. -

Additional file types can be added to mime.types or -(preferably) in additional files in the CUPS configuration -directory with the extension ".types". -

Each line in the mime.types file is a comment, blank, or -rule line. Comment lines start with the # character. Rule lines -start with the MIME type name and are optionally followed by a -series of file recognition rules that are used to automatically -identify print and web files: -
+The mime.types file defines the recognized file types. +

Additional file types are specified in files with the extension .types in the CUPS configuration directory. +

Each line in the mime.types file is a comment, blank, or rule line. +Comment lines start with the # character. +Rule lines start with the MIME media type and are optionally followed by a series of file recognition rules: 

 
-    super/type rule [ ... ruleN]
+    mime/type [ rule ... rule ]
+
+
+Rules can be extended over multiple lines using the backslash character (\): +
+
+    mime/type [ really-really-really-long-rule ... \
+      rule ]
+
-MIME type names are case-insensitive and are sorted in ascending alphanumeric -order for the purposes of matching. See the "TYPE MATCHING AND PRIORITY" -section for more information. -

The rules may be grouped using parenthesis, joined using "+" for a -logical AND and "," or whitespace for a logical OR, and negated using -"!". -

Rules

+MIME media types specified by the mime/type field are case-insensitive and are sorted in ascending alphanumeric order for the purposes of matching. +See the "TYPE MATCHING AND PRIORITY" section for more information. +

The rules may be grouped using parenthesis, joined using "+" for a logical AND, joined using "," or whitespace for a logical OR, and negated using "!". +

Rules

Rules take two forms - a filename extension by itself and functions with test -values inside parenthesis. The following functions are available: +values inside parenthesis. +The following functions are available:
-
match("pattern") -

-Pattern match on filename -
ascii(offset,length) -

-True if bytes are valid printable ASCII (CR, NL, TAB, BS, 32-126) -
printable(offset,length) -

-True if bytes are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254) -
priority(number) -

-Specifies the relative priority of this MIME type. The default priority is 100. +
match("pattern") +
True if the filename matches the given shell wildcard pattern. +
ascii(offset,length) +
True if the length bytes starting at offset are valid printable ASCII (CR, NL, TAB, BS, 32-126). +
printable(offset,length) +
True if the length bytes starting at offset are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254). +
priority(number) +
Specifies the relative priority of this MIME media type. +The default priority is 100. Larger values have higher priority while smaller values have lower priority. -
string(offset,"string") -

-True if bytes are identical to string -
istring(offset,"string") -

-True if a case-insensitive comparison of the bytes is identical -
char(offset,value) -

-True if byte is identical -
short(offset,value) -

-True if 16-bit integer is identical -
int(offset,value) -

-True if 32-bit integer is identical -
locale("string") -

-True if current locale matches string -
contains(offset,range,"string") -

-True if the range contains the string +
string(offset,"string") +
True if the bytes starting at offset are identical to string. +
istring(offset,"string") +
True if the bytes starting at offset match string without respect to case. +
char(offset,value) +
True if the byte at offset is identical to value. +
short(offset,value) +
True if the 16-bit big-endian integer at offset is identical to value. +
int(offset,value) +
True if the 32-bit big-endian integer at offset is identical to value. +
locale("string") +
True if current locale matches string. +
contains(offset,range,"string") +
True if the bytes starting at offset for range bytes contains string.
-

String Constants

-String constants can be specified inside quotes ("") for strings -containing whitespace and angle brackets (<>) for hexadecimal -strings. -

Type Matching And Priority

-When CUPS needs to determine the MIME type of a given file, it checks every -MIME type defined in the .types files. When two types have the same matching -rules, the type chosen will depend on the type name and priority, with higher- -priority types being used over lower-priority ones. If the types have the same -priority, the type names are sorted alphanumerically in ascending order and the -first type is chosen. +

String Constants

+String constants can be specified inside quotes ("") for strings containing whitespace and angle brackets (<>) for hexadecimal strings. +

Type Matching And Priority

+When CUPS needs to determine the MIME media type of a given file, it checks every MIME media type defined in the .types files. +When two or more types match a given file, the type chosen will depend on the type name and priority, with higher-priority types being used over lower-priority ones. +If the types have the same priority, the type names are sorted alphanumerically in ascending order and the first type is chosen.

For example, if two types "text/bar" and "text/foo" are defined as matching the extension "doc", normally the type "text/bar" will be chosen since its name is -alphanumerically smaller than "text/foo". However, if "text/foo" also defines a -higher priority than "text/bar", "text/foo" will be chosen instead. +alphanumerically smaller than "text/foo". +However, if "text/foo" also defines a higher priority than "text/bar", "text/foo" will be chosen instead. +

Files

+/etc/cups - Typical CUPS configuration directory. +

Examples

+Define two MIME media types for raster data, with one being a subset with higher priority: +
+
+    application/vnd.cups-raster  string(0,"RaSt") string(0,"tSaR") \
+                                  string(0,"RaS2") string(0,"2SaR") \
+                                  string(0,"RaS3") string(0,"3SaR")
+
+    image/pwg-raster              string(0,"RaS2") + \
+                                  string(4,PwgRaster<00>) priority(150)
+

See Also

-classes.conf(5), cupsd(8), cupsd.conf(5), -mime.convs(5), printers.conf(5), -
-http://localhost:631/help +cups-files.conf(5), +cupsd.conf(5), +cupsd(8), +cupsfilter(8), +mime.convs(5), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-notifier.html b/doc/help/man-notifier.html index 01727e075..5c65778d1 100644 --- a/doc/help/man-notifier.html +++ b/doc/help/man-notifier.html @@ -16,120 +16,22 @@ notifier - cups notification interface user-data ]

Description

-The CUPS notifier interface provides a standard method for adding support for -new event notification methods to CUPS. Each notifier delivers one or more IPP -events from the standard input to the specified recipient. -

Notifiers must read IPP messages from the standard input using the -ippNew and ippReadFile functions and exit on error. Notifiers are encouraged to -exit after a suitable period of inactivity, however they may exit after reading -the first message or stay running until an error is seen. -

Log Messages

-Messages sent to stderr are generally logged to the current ErrorLog. -Each line begins with a standard prefix: - -
-
ALERT: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "alert" log level. - -
CRIT: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "critical" log level. - -
DEBUG: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "debug" log level. - -
DEBUG2: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "debug2" log level. - -
EMERG: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "emergency" log level. - -
ERROR: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "error" log level. - -
INFO: message -

-Sets the printer-state-message attribute. If the current LogLevel -is set to "debug2", also adds the specified message to the -current ErrorLog using the "info" log level. - -
NOTICE: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "notice" log level. - -
WARNING: message -

-Sets the printer-state-message attribute and adds the specified -message to the current ErrorLog using the "warning" log level. - -
-

Environment Variables

-The following environment variables are defined by the CUPS server when -executing the notifier: - -
-
CHARSET -

-The default text character set, typically utf-8. - -
CUPS_CACHEDIR -

-The directory for semi-persistent cache files can be found. - -
CUPS_DATADIR -

-The directory where data files can be found. - -
CUPS_FILETYPE -

-The type of file being printed: "job-sheet" for a banner page and "document" -for a regular print file. - -
CUPS_SERVERROOT -

-The root directory of the server. - -
LANG -

-The default language locale (typically C or en). - -
PATH -

-The standard execution path for external programs that may be run by -the filter. - -
SOFTWARE -

-The name and version number of the server (typically CUPS/1.2). - -
TZ -

-The timezone of the server. - -
USER -

-The user executing the filter, typically "lp"; consult the cupsd.conf(5) -file for the current setting. - -
+The CUPS notifier interface provides a standard method for adding support for new event notification methods to CUPS. +Each notifier delivers one or more IPP events from the standard input to the specified recipient. +

Notifiers MUST read IPP messages from the standard input using the +ippNew() +and +ippReadFile() +functions and exit on error. +Notifiers are encouraged to exit after a suitable period of inactivity, however they may exit after reading the first message or stay running until an error is seen. +Notifiers inherit the environment and can use the logging mechanism documented in +filter(7).

See Also

-backend(7), cupsd(8), filter(7), -
-http://localhost:631/help +cupsd(8), +filter(7), +CUPS Online Help (http://localhost:631/help)

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-ppdc.html b/doc/help/man-ppdc.html index d85d66411..a47b0d3cb 100644 --- a/doc/help/man-ppdc.html +++ b/doc/help/man-ppdc.html @@ -11,28 +11,42 @@ ppdc - cups ppd compiler

Synopsis

ppdc -[ -D -name[=value] -] [ -I +[ +-D name[=value] +] [ +-I include-directory -] [ -c +] [ +-c message-catalog -] [ -d +] [ +-d output-directory -] [ -l +] [ +-l language(s) -] [-m] [-t] [ -v ] [ -z ] [ --cr ] [ --crlf ] [ --lf ] +] [ +-m +] [ +-t +] [ +-v +] [ +-z +] [ +--cr +] [ +--crlf +] [ +--lf +] source-file

Description

-ppdc compiles PPDC source files into one or more PPD -files. This program is deprecated and will be removed in a future release of -CUPS. -

The -D option sets the named variable for use in the -source file. It is equivalent to using the #define directive -in the source file. -

The -I option specifies an alternate include directory; -multiple -I options can be supplied to add additional -directories. +ppdc compiles PPDC source files into one or more PPD files. +This program is deprecated and will be removed in a future release of CUPS. +

The -D option sets the named variable for use in the source file. +It is equivalent to using the #define directive in the source file. +

The -I option specifies an alternate include directory; multiple -I options can be supplied to add additional directories.

The -c option specifies a single message catalog file in GNU gettext source format (filename.po) to be used for localization.

The -d option specifies the output directory for PPD diff --git a/man/lpq.man b/man/lpq.man index 9a41b64bd..9286d808e 100644 --- a/man/lpq.man +++ b/man/lpq.man @@ -1,72 +1,72 @@ .\" .\" "$Id$" .\" -.\" lpq man page for CUPS. +.\" lpq 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 lpq 1 "CUPS" "16 June 2008" "Apple Inc." +.TH lpq 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME lpq \- show printer queue status .SH SYNOPSIS .B lpq -[ -E ] [ -U +[ +.B \-E +] [ +.B \-U .I username -] [ -h -.I server[:port] -] [ -P -.I destination[/instance] -] [ -a ] [ -l ] [ -.I +interval +] [ +\fB\-h \fIserver\fR[\fB:\fIport\fR] +] [ +\fB\-P \fIdestination\fR[\fB/\fIinstance\fR] +] [ +.B \-a +] [ +.B \-l +] [ +.BI + interval ] .SH DESCRIPTION -\fIlpq\fR shows the current print queue status on the named -printer. Jobs queued on the default destination will be shown if -no printer or class is specified on the command-line. +\fBlpq\fR shows the current print queue status on the named printer. +Jobs queued on the default destination will be shown if no printer or class is specified on the command-line. .LP -The \fI+interval\fR option allows you to continuously report the -jobs in the queue until the queue is empty; the list of jobs is -shown once every \fIinterval\fR seconds. +The \fI+interval\fR option allows you to continuously report the jobs in the queue until the queue is empty; the list of jobs is shown once every \fIinterval\fR seconds. .SH OPTIONS -\fIlpq\fR supports the following options: +\fBlpq\fR supports the following options: .TP 5 --E -.br +.B \-E Forces encryption when connecting to the server. .TP 5 --P destination[/instance] -.br +\fB\-P \fIdestination\fR[\fB/\fIinstance\fR] Specifies an alternate printer or class name. .TP 5 --U username -.br +\fB\-U \fIusername\fR Specifies an alternate username. .TP 5 --a -.br +.B \-a Reports jobs on all printers. .TP 5 --h server[:port] -.br +\fB\-h \fIserver\fR[\fB:\fIport\fR] Specifies an alternate server. .TP 5 --l -.br +.B \-l Requests a more verbose (long) reporting format. .SH SEE ALSO -\fIcancel(1)\fR, \fIlp(1)\fR, \fIlpr(1)\fR, \fIlprm(1)\fR, -\fIlpstat(1)\fR, -.br -http://localhost:631/help +.BR cancel (1), +.BR lp (1), +.BR lpr (1), +.BR lprm (1), +.BR lpstat (1), +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/lpstat.man b/man/lpstat.man index cad3e4119..569ba0e8b 100644 --- a/man/lpstat.man +++ b/man/lpstat.man @@ -1,143 +1,152 @@ .\" .\" "$Id$" .\" -.\" lpstat man page for CUPS. +.\" lpstat 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 lpstat 1 "CUPS" "10 September 2008" "Apple Inc." +.TH lpstat 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME lpstat \- print cups status information .SH SYNOPSIS .B lpstat -[ -E ] [ -H ] [ -U +[ +.B \-E +] [ +.B \-H +] [ +.B \-U .I username -] [ -h -.I hostname[:port] -] [ -l ] [ -W +] [ +\fB\-h \fIhostname\fR[\fB:\fIport\fR] +] [ +.B \-l +] [ +.B \-W .I which-jobs -] [ -a [ +] [ +.B \-a +[ .I destination(s) -] ] [ -c [ +] ] [ +.B \-c +[ .I class(es) -] ] [ -d ] [ -o [ +] ] [ +.B \-d +] [ +.B \-o +[ .I destination(s) -] ] [ -p [ +] ] [ +.B \-p +[ .I printer(s) -] ] [ -r ] [ -R ] [ -s ] [ -t ] [ -u [ +] ] [ +.B \-r +] [ +.B \-R +] [ +.B \-s +] [ +.B \-t +] [ +.B \-u +[ .I user(s) -] ] [ -v [ +] ] [ +.B \-v +[ .I printer(s) ] ] .SH DESCRIPTION -\fIlpstat\fR displays status information about the current -classes, jobs, and printers. When run with no arguments, -\fIlpstat\fR will list jobs queued by the current user. +\fBlpstat\fR displays status information about the current classes, jobs, and printers. +When run with no arguments, \fBlpstat\fR will list active jobs queued by the current user. .SH OPTIONS -The \fIlpstat\fR command supports the following options: +The \fBlpstat\fR command supports the following options: .TP 5 --E -.br +.B \-E Forces encryption when connecting to the server. .TP 5 --H -.br +.B \-H Shows the server hostname and port. .TP 5 --R -.br +.B \-R Shows the ranking of print jobs. .TP 5 --U username -.br +\fB\-U \fIusername\fR Specifies an alternate username. .TP 5 --W which-jobs -.br -Specifies which jobs to show, \fIcompleted\fR or -\fInot-completed\fR (the default). This option \fImust\fR appear -before the \fI-o\fR option and/or any printer names, otherwise -the default (not-completed) value will be used in the request to -the scheduler. -.TP 5 --a [printer(s)] -.br -Shows the accepting state of printer queues. If no printers are -specified then all printers are listed. -.TP 5 --c [class(es)] -.br +\fB\-W \fIwhich-jobs\fR +Specifies which jobs to show, "completed" or "not-completed" (the default). +This option \fImust\fR appear before the \fI-o\fR option and/or any printer names, otherwise the default ("not-completed") value will be used in the request to the scheduler. +.TP 5 +\fB\-a \fR[\fIprinter(s)\fR] +Shows the accepting state of printer queues. +If no printers are specified then all printers are listed. +.TP 5 +\fB\-c \fR[\fIclass(es)\fR] Shows the printer classes and the printers that belong to them. If no classes are specified then all classes are listed. .TP 5 --d -.br +.B \-d Shows the current default destination. .TP 5 --h server[:port] -.br +\fB\-h \fIserver\fR[\fB:\fIport\fR] Specifies an alternate server. .TP 5 --l -.br +.B \-l Shows a long listing of printers, classes, or jobs. .TP 5 --o [destination(s)] -.br -Shows the jobs queue on the specified destinations. If no destinations are -specified all jobs are shown. +\fB\-o \fR[\fIdestination(s)\fR] +Shows the jobs queued on the specified destinations. +If no destinations are specified all jobs are shown. .TP 5 --p [printer(s)] -.br -Shows the printers and whether or not they are enabled for printing. If -no printers are specified then all printers are listed. +\fB\-p \fR[\fIprinter(s)\fR] +Shows the printers and whether they are enabled for printing. +If no printers are specified then all printers are listed. .TP 5 --r -.br +.B \-r Shows whether the CUPS server is running. .TP 5 --s -.br -Shows a status summary, including the default destination, a -list of classes and their member printers, and a list of printers and -their associated devices. This is equivalent to using the "-d", "-c", -and "-v" options. -.TP 5 --t -.br -Shows all status information. This is equivalent to using the "-r", -"-d", "-c", "-v", "-a", "-p", and "-o" options. -.TP 5 --u [user(s)] -.br -Shows a list of print jobs queued by the specified users. If no users -are specified, lists the jobs queued by the current user. -.TP 5 --v [printer(s)] -.br -Shows the printers and what device they are attached to. If no printers -are specified then all printers are listed. -.SH COMPATIBILITY -Unlike the System V printing system, CUPS allows printer names to -contain any printable character except SPACE, TAB, "/", and "#". +.B \-s +Shows a status summary, including the default destination, a list of classes and their member printers, and a list of printers and their associated devices. +This is equivalent to using the \fI\-d\fR, \fI\-c\fR, and \fI\-v\fR options. +.TP 5 +.B \-t +Shows all status information. +This is equivalent to using the \fI\-r\fR, \fI\-d\fR, \fI\-c\fR, \fI\-v\fR, \fI\-a\fR, \fI\-p\fR, and \fI\-o\fR options. +.TP 5 +\fB\-u \fR[\fIuser(s)\fR] +Shows a list of print jobs queued by the specified users. +If no users are specified, lists the jobs queued by the current user. +.TP 5 +\fB\-v \fR[\fIprinter(s)\fR] +Shows the printers and what device they are attached to. +If no printers are specified then all printers are listed. +.SH CONFORMING TO +Unlike the System V printing system, CUPS allows printer names to contain any printable character except SPACE, TAB, "/", and "#". Also, printer and class names are \fInot\fR case-sensitive. .LP -The "-h", "-E", "-U", and "-W" options are unique to CUPS. +The \fI\-h\fR, \fI\-E\fR, \fI\-U\fR, and \fI\-W\fR options are unique to CUPS. .LP -The Solaris "-f", "-P", and "-S" options are silently ignored. +The Solaris \fI\-f\fR, \fI\-P\fR, and \fI\-S\fR options are silently ignored. .SH SEE ALSO -\fIcancel(1)\fR, \fIlp(1)\fR, -.br -http://localhost:631/help +.BR cancel (1), +.BR lp (1), +.BR lpq (1), +.BR lpr (1), +.BR lprm (1), +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/mailto.conf.man b/man/mailto.conf.man index a16bb5485..89b2989bd 100644 --- a/man/mailto.conf.man +++ b/man/mailto.conf.man @@ -1,60 +1,52 @@ .\" .\" "$Id$" .\" -.\" mailto.conf man page for CUPS. +.\" mailto.conf 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 mailto.conf 5 "CUPS" "12 July 2006" "Apple Inc." +.TH mailto.conf 5 "CUPS" "12 June 2014" "Apple Inc." .SH NAME mailto.conf \- configuration file for cups email notifier .SH DESCRIPTION -The \fImailto.conf\fR file defines the local mail server and -email notification preferences for CUPS. +The \fBmailto.conf\fR file defines the local mail server and email notification preferences for CUPS. .LP -Each line in the file can be a configuration directive, a blank line, -or a comment. Comment lines start with the # character. -.SH DIRECTIVES +Each line in the file can be a configuration directive, a blank line, or a comment. +Configuration directives typically consist of a name and zero or more values separated by whitespace. +The configuration directive name and values are case-insensitive. +Comment lines start with the # character. +.SS DIRECTIVES .TP 5 -Cc \fIcc-address@domain.com\fR -.br +\fBCc \fIcc-address@domain.com\fR Specifies an additional recipient for all email notifications. .TP 5 -From \fIfrom-address@domain.com\fR -.br +\fBFrom \fIfrom-address@domain.com\fR Specifies the sender of email notifications. .TP 5 -Sendmail \fIsendmail command and options\fR -.br -Specifies the sendmail command to use when sending email -notifications. Only one \fISendmail\fR or \fISMTPServer\fR line -may be present in the \fImailto.conf\fR file. If multiple lines -are present, only the last one is used. +\fBSendmail \fIsendmail command and options\fR +Specifies the sendmail command to use when sending email notifications. +Only one \fISendmail\fR or \fISMTPServer\fR line may be present in the \fBmailto.conf\fR file. +If multiple lines are present, only the last one is used. .TP 5 -SMTPServer \fIservername\fR -.br -Specifies a SMTP server to send email notifications to. Only one -\fISendmail\fR or \fISMTPServer\fR line may be present in the -\fImailto.conf\fR file. If multiple lines are present, only the -last one is used. +\fBSMTPServer \fIservername\fR +Specifies a SMTP server to send email notifications to. +Only one \fISendmail\fR or \fISMTPServer\fR line may be present in the \fBmailto.conf\fR file. +If multiple lines are present, only the last one is used. .TP 5 -Subject \fIsubject-prefix\fR -.br +\fBSubject \fIsubject-prefix\fR Specifies a prefix string for the subject line of an email notification. .SH SEE ALSO -\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, -\fImime.convs(5)\fR, \fImime.types(5)\fR, \fIprinters.conf(5)\fR, -.br -http://localhost:631/help +.BR cupsd (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/mime.convs.man b/man/mime.convs.man index 146eb1372..4a67bcd96 100644 --- a/man/mime.convs.man +++ b/man/mime.convs.man @@ -1,46 +1,66 @@ .\" .\" "$Id$" .\" -.\" mime.convs man page for CUPS. +.\" mime.convs 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 mime.convs 5 "CUPS" "20 March 2006" "Apple Inc." +.TH mime.convs 5 "CUPS" "12 June 2014" "Apple Inc." .SH NAME mime.convs \- mime type conversion file for cups .SH DESCRIPTION -The \fImime.convs\fR file defines the filters that are available -for converting files from one format to another. The standard -filters support text, PDF, PostScript, HP-GL/2, and many types of -image files. +The \fBmime.convs\fR file defines the filters that are available for converting files from one format to another. +The standard filters support text, PDF, PostScript, and many types of image files. .LP -Additional filters can be added to the \fImime.convs\fR file or -(preferably) to other files in the CUPS configuration directory. +Additional filters are specified in files with the extension \fI.convs\fR in the CUPS configuration directory. .LP -Each line in the \fImime.convs\fR file is a comment, blank, or filter -line. Comment lines start with the # character. Filter lines specify -the source and destination MIME types along with a relative cost -associated with the filter and the filter to run: +Each line in the \fBmime.convs\fR file is a comment, blank, or filter +line. +Comment lines start with the # character. +Filter lines specify the source and destination MIME types along with a relative cost associated with the filter and the filter to run: +.nf + + source/type destination/type cost filter + +.fi +The \fIsource/type\fR field specifies the source MIME media type that is consumed by the filter. +.LP +The \fIdestination/type\fR field specifies the destiantion MIME media type that is produced by the filter. +.LP +The \fIcost\fR field specifies the relative cost for running the filter. +A value of 100 means that the filter uses a large amount of resources while a value of 0 means that the filter uses very few resources. +.LP +The \fIfilter\fR field specifies the filter program filename. +Filenames are relative to the CUPS filter directory. +.SH FILES +\fI/etc/cups\fR - Typical CUPS configuration directory. +.br +\fI/usr/lib/cups/filter\fR - Typical CUPS filter directory. .br +\fI/usr/libexec/cups/filter\fR - CUPS filter directory on OS X. +.SH EXAMPLES +Define a filter that converts PostScript documents to CUPS Raster format: .nf -super/type super/type cost filter -application/postscript application/vnd.cups-raster 50 pstoraster + application/vnd.cups\-postscript application/vnd.cups\-raster 50 pstoraster + .fi .SH SEE ALSO -\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, -\fImime.types(5)\fR, \fIprinters.conf(5)\fR, -.br -http://localhost:631/help +.BR cups-files.conf (5), +.BR cupsd.conf (5), +.BR cupsd (8), +.BR cupsfilter (8), +.BR mime.types (5), +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/mime.types.man b/man/mime.types.man index f97d30887..184c1883c 100644 --- a/man/mime.types.man +++ b/man/mime.types.man @@ -1,115 +1,116 @@ .\" .\" "$Id$" .\" -.\" mime.types man page for CUPS. +.\" mime.types 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 mime.types 5 "CUPS" "16 May 2009" "Apple Inc." +.TH mime.types 5 "CUPS" "12 June 2014" "Apple Inc." .SH NAME mime.types \- mime type description file for cups .SH DESCRIPTION -The \fImime.types\fR file defines the recognized file types. +The \fBmime.types\fR file defines the recognized file types. .LP -Additional file types can be added to \fImime.types\fR or -(preferably) in additional files in the CUPS configuration -directory with the extension ".types". +Additional file types are specified in files with the extension \fI.types\fR in the CUPS configuration directory. .LP -Each line in the \fImime.types\fR file is a comment, blank, or -rule line. Comment lines start with the # character. Rule lines -start with the MIME type name and are optionally followed by a -series of file recognition rules that are used to automatically -identify print and web files: -.br +Each line in the \fBmime.types\fR file is a comment, blank, or rule line. +Comment lines start with the # character. +Rule lines start with the MIME media type and are optionally followed by a series of file recognition rules: .nf - super/type rule [ ... ruleN] + \fImime/type \fR[ \fIrule \fR... \fIrule \fR] + +.fi +Rules can be extended over multiple lines using the backslash character (\\): +.nf + + \fImime/type \fR[ \fIreally-really-really-long-rule \fR... \fB\\ + \fIrule \fR] + .fi -MIME type names are case-insensitive and are sorted in ascending alphanumeric -order for the purposes of matching. See the "TYPE MATCHING AND PRIORITY" -section for more information. +MIME media types specified by the \fImime/type\fR field are case-insensitive and are sorted in ascending alphanumeric order for the purposes of matching. +See the "TYPE MATCHING AND PRIORITY" section for more information. .LP -The rules may be grouped using parenthesis, joined using "+" for a -logical AND and "," or whitespace for a logical OR, and negated using -"!". -.SH RULES +The rules may be grouped using parenthesis, joined using "+" for a logical AND, joined using "," or whitespace for a logical OR, and negated using "!". +.SS RULES Rules take two forms - a filename extension by itself and functions with test -values inside parenthesis. The following functions are available: +values inside parenthesis. +The following functions are available: .TP 5 -match("pattern") -.br -Pattern match on filename +\fBmatch("\fIpattern\fB")\fR +True if the filename matches the given shell wildcard \fIpattern\fR. .TP 5 -ascii(offset,length) -.br -True if bytes are valid printable ASCII (CR, NL, TAB, BS, 32-126) +\fBascii(\fIoffset\fB,\fIlength\fB)\fR +True if the \fIlength\fR bytes starting at \fIoffset\fR are valid printable ASCII (CR, NL, TAB, BS, 32-126). .TP 5 -printable(offset,length) -.br -True if bytes are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254) +\fBprintable(\fIoffset\fB,\fIlength\fB)\fR +True if the \fIlength\fR bytes starting at \fIoffset\fR are printable 8-bit chars (CR, NL, TAB, BS, 32-126, 128-254). .TP 5 -priority(number) -.br -Specifies the relative priority of this MIME type. The default priority is 100. +\fBpriority(\fInumber\fB)\fR +Specifies the relative priority of this MIME media type. +The default priority is 100. Larger values have higher priority while smaller values have lower priority. .TP 5 -string(offset,"string") -.br -True if bytes are identical to string +\fBstring(\fIoffset\fB,"\fIstring\fB")\fR +True if the bytes starting at \fIoffset\fR are identical to \fIstring\fR. .TP 5 -istring(offset,"string") -.br -True if a case-insensitive comparison of the bytes is identical +\fBistring(\fIoffset\fB,"\fIstring\fB")\fR +True if the bytes starting at \fIoffset\fR match \fIstring\fR without respect to case. .TP 5 -char(offset,value) -.br -True if byte is identical +\fBchar(\fIoffset\fB,\fIvalue\fB)\fR +True if the byte at \fIoffset\fR is identical to \fIvalue\fR. .TP 5 -short(offset,value) -.br -True if 16-bit integer is identical +\fBshort(\fIoffset\fB,\fIvalue\fB)\fR +True if the 16-bit big-endian integer at \fIoffset\fR is identical to \fIvalue\fR. .TP 5 -int(offset,value) -.br -True if 32-bit integer is identical +\fBint(\fIoffset\fB,\fIvalue\fB)\fR +True if the 32-bit big-endian integer at \fIoffset\fR is identical to \fIvalue\fR. .TP 5 -locale("string") -.br -True if current locale matches string +\fBlocale("\fIstring\fB")\fR +True if current locale matches \fIstring\fR. .TP 5 -contains(offset,range,"string") -.br -True if the range contains the string -.SH STRING CONSTANTS -String constants can be specified inside quotes ("") for strings -containing whitespace and angle brackets (<>) for hexadecimal -strings. -.SH TYPE MATCHING AND PRIORITY -When CUPS needs to determine the MIME type of a given file, it checks every -MIME type defined in the .types files. When two types have the same matching -rules, the type chosen will depend on the type name and priority, with higher- -priority types being used over lower-priority ones. If the types have the same -priority, the type names are sorted alphanumerically in ascending order and the -first type is chosen. +\fBcontains(\fIoffset\fB,\fIrange\fB,"\fIstring\fB")\fR +True if the bytes starting at \fIoffset\fR for \fIrange\fR bytes contains \fIstring\fR. +.SS STRING CONSTANTS +String constants can be specified inside quotes ("") for strings containing whitespace and angle brackets (<>) for hexadecimal strings. +.SS TYPE MATCHING AND PRIORITY +When CUPS needs to determine the MIME media type of a given file, it checks every MIME media type defined in the \fI.types\fR files. +When two or more types match a given file, the type chosen will depend on the type name and priority, with higher-priority types being used over lower-priority ones. +If the types have the same priority, the type names are sorted alphanumerically in ascending order and the first type is chosen. .LP For example, if two types "text/bar" and "text/foo" are defined as matching the extension "doc", normally the type "text/bar" will be chosen since its name is -alphanumerically smaller than "text/foo". However, if "text/foo" also defines a -higher priority than "text/bar", "text/foo" will be chosen instead. +alphanumerically smaller than "text/foo". +However, if "text/foo" also defines a higher priority than "text/bar", "text/foo" will be chosen instead. +.SH FILES +\fI/etc/cups\fR - Typical CUPS configuration directory. +.SH EXAMPLES +Define two MIME media types for raster data, with one being a subset with higher priority: +.nf + + application/vnd.cups\-raster string(0,"RaSt") string(0,"tSaR") \\ + string(0,"RaS2") string(0,"2SaR") \\ + string(0,"RaS3") string(0,"3SaR") + + image/pwg-raster string(0,"RaS2") + \\ + string(4,PwgRaster<00>) priority(150) +.fi .SH SEE ALSO -\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, -\fImime.convs(5)\fR, \fIprinters.conf(5)\fR, -.br -http://localhost:631/help +.BR cups-files.conf (5), +.BR cupsd.conf (5), +.BR cupsd (8), +.BR cupsfilter (8), +.BR mime.convs (5), +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/notifier.man b/man/notifier.man index 411287868..05edf1296 100644 --- a/man/notifier.man +++ b/man/notifier.man @@ -1,18 +1,18 @@ .\" .\" "$Id$" .\" -.\" notifier man page for CUPS. +.\" notifier man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 1997-2007 by Easy Software Products. +.\" Copyright 2007-2014 by Apple Inc. +.\" Copyright 1997-2007 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 notifier 7 "CUPS" "12 May 2009" "Apple Inc." +.TH notifier 7 "CUPS" "12 June 2014" "Apple Inc." .SH NAME notifier \- cups notification interface .SH SYNOPSIS @@ -22,136 +22,23 @@ notifier \- cups notification interface .I user-data ] .SH DESCRIPTION -The CUPS notifier interface provides a standard method for adding support for -new event notification methods to CUPS. Each notifier delivers one or more IPP -events from the standard input to the specified recipient. +The CUPS notifier interface provides a standard method for adding support for new event notification methods to CUPS. +Each notifier delivers one or more IPP events from the standard input to the specified recipient. .LP -Notifiers \fBmust\fR read IPP messages from the standard input using the -ippNew and ippReadFile functions and exit on error. Notifiers are encouraged to -exit after a suitable period of inactivity, however they may exit after reading -the first message or stay running until an error is seen. -.SH LOG MESSAGES -Messages sent to stderr are generally logged to the current \fIErrorLog\fR. -Each line begins with a standard prefix: - -.TP 5 -ALERT: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "alert" log level. - -.TP 5 -CRIT: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "critical" log level. - -.TP 5 -DEBUG: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "debug" log level. - -.TP 5 -DEBUG2: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "debug2" log level. - -.TP 5 -EMERG: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "emergency" log level. - -.TP 5 -ERROR: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "error" log level. - -.TP 5 -INFO: message -.br -Sets the printer-state-message attribute. If the current \fILogLevel\fR -is set to "debug2", also adds the specified message to the -current \fIErrorLog\fR using the "info" log level. - -.TP 5 -NOTICE: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "notice" log level. - -.TP 5 -WARNING: message -.br -Sets the printer-state-message attribute and adds the specified -message to the current \fIErrorLog\fR using the "warning" log level. - -.SH ENVIRONMENT VARIABLES -The following environment variables are defined by the CUPS server when -executing the notifier: - -.TP 5 -CHARSET -.br -The default text character set, typically utf-8. - -.TP 5 -CUPS_CACHEDIR -.br -The directory for semi-persistent cache files can be found. - -.TP 5 -CUPS_DATADIR -.br -The directory where data files can be found. - -.TP 5 -CUPS_FILETYPE -.br -The type of file being printed: "job-sheet" for a banner page and "document" -for a regular print file. - -.TP 5 -CUPS_SERVERROOT -.br -The root directory of the server. - -.TP 5 -LANG -.br -The default language locale (typically C or en). - -.TP 5 -PATH -.br -The standard execution path for external programs that may be run by -the filter. - -.TP 5 -SOFTWARE -.br -The name and version number of the server (typically CUPS/1.2). - -.TP 5 -TZ -.br -The timezone of the server. - -.TP 5 -USER -.br -The user executing the filter, typically "lp"; consult the \fIcupsd.conf(5)\fR -file for the current setting. - +Notifiers \fBMUST\fR read IPP messages from the standard input using the +.BR ippNew () +and +.BR ippReadFile () +functions and exit on error. +Notifiers are encouraged to exit after a suitable period of inactivity, however they may exit after reading the first message or stay running until an error is seen. +Notifiers inherit the environment and can use the logging mechanism documented in +.BR filter (7). .SH SEE ALSO -\fIbackend(7)\fR, \fIcupsd(8)\fR, \fIfilter(7)\fR, -.br -http://localhost:631/help +.BR cupsd (8), +.BR filter (7), +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/ppdc.man b/man/ppdc.man index 1d74a1561..1c94a727f 100644 --- a/man/ppdc.man +++ b/man/ppdc.man @@ -1,46 +1,60 @@ .\" .\" "$Id$" .\" -.\" ppdc man page for CUPS. +.\" ppdc man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 1997-2007 by Easy Software Products. +.\" Copyright 2007-2014 by Apple Inc. +.\" Copyright 1997-2007 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 ppdc 1 "CUPS" "15 February 2012" "Apple Inc." +.TH ppdc 1 "CUPS" "12 June 2014" "Apple Inc." .SH NAME ppdc \- cups ppd compiler .SH SYNOPSIS .B ppdc -[ -D -.I name[=value] -] [ -I +[ +\fB\-D \fIname\fR[\fB=\fIvalue\fR] +] [ +.B \-I .I include-directory -] [ -c +] [ +.B \-c .I message-catalog -] [ -d +] [ +.B \-d .I output-directory -] [ -l +] [ +.B \-l .I language(s) -] [-m] [-t] [ -v ] [ -z ] [ --cr ] [ --crlf ] [ --lf ] +] [ +.B \-m +] [ +.B \-t +] [ +.B \-v +] [ +.B \-z +] [ +.B \-\-cr +] [ +.B \-\-crlf +] [ +.B \-\-lf +] .I source-file .SH DESCRIPTION -\fIppdc\fR compiles PPDC source files into one or more PPD -files. \fBThis program is deprecated and will be removed in a future release of -CUPS.\fR +\fBppdc\fR compiles PPDC source files into one or more PPD files. +\fBThis program is deprecated and will be removed in a future release of CUPS.\fR .PP -The \fI-D\fR option sets the named variable for use in the -source file. It is equivalent to using the #define directive -in the source file. +The \fI-D\fR option sets the named variable for use in the source file. +It is equivalent to using the \fI#define\fR directive in the source file. .PP -The \fI-I\fR option specifies an alternate include directory; -multiple \fI-I\fR options can be supplied to add additional -directories. +The \fI-I\fR option specifies an alternate include directory; multiple \fI-I\fR options can be supplied to add additional directories. .PP The \fI-c\fR option specifies a single message catalog file in GNU gettext source format (filename.po) to be used for localization.