From 7131e2853ab6765e63e13d8faacc84b0ff903305 Mon Sep 17 00:00:00 2001 From: msweet Date: Tue, 15 Apr 2014 16:31:11 +0000 Subject: [PATCH] More man page modernization. Combine and simplify documentation of cupsd helper programs into a single man page. Document the client.conf file as deprecated. Document the classes.conf, printers.conf, and subscriptions.conf files as subject to be changed and not to be hand-edited. Remove separate HTML documentation for client.conf - the man page is now "good enough"... Fix usage comment at the top of cups-exec.c. git-svn-id: svn+ssh://src.apple.com/svn/cups/cups.org/trunk@11817 a1ca3aef-8c08-0410-bb20-df032aa958be --- doc/Makefile | 3 +- doc/help/man-cancel.html | 91 +++++---- doc/help/man-cups-deviced.html | 38 ---- doc/help/man-cups-driverd.html | 112 ----------- doc/help/man-cupsd.conf.html | 326 ++++++++++++++++++++------------- doc/help/man-cupsd.html | 89 ++------- doc/help/ref-client-conf.html | 94 ---------- man/Makefile | 3 +- man/cancel.man | 111 ++++++----- man/classes.conf.man | 118 +++--------- man/client.conf.man.in | 79 ++++---- man/cups-config.man | 153 ++++++++-------- man/cups-deviced.man.in | 44 ----- man/cups-driverd.man.in | 122 ------------ man/cupsd-helper.man | 94 ++++++++++ man/printers.conf.man | 132 +++---------- man/subscriptions.conf.man | 99 +++------- scheduler/cups-exec.c | 2 +- 18 files changed, 605 insertions(+), 1105 deletions(-) delete mode 100644 doc/help/man-cups-deviced.html delete mode 100644 doc/help/man-cups-driverd.html delete mode 100644 doc/help/ref-client-conf.html delete mode 100644 man/cups-deviced.man.in delete mode 100644 man/cups-driverd.man.in create mode 100644 man/cupsd-helper.man diff --git a/doc/Makefile b/doc/Makefile index db6adad14..1b3de8c87 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -64,6 +64,7 @@ HELPFILES = \ help/license.html \ help/man-backend.html \ help/man-cancel.html \ + help/man-client.conf.html \ help/man-cups.html \ help/man-cups-config.html \ help/man-cups-lpd.html \ @@ -71,6 +72,7 @@ HELPFILES = \ help/man-cupsaccept.html \ help/man-cupsaddsmb.html \ help/man-cupsd.html \ + help/man-cupsd-helper.html \ help/man-cupsenable.html \ help/man-cupstestdsc.html \ help/man-cupstestppd.html \ @@ -104,7 +106,6 @@ HELPFILES = \ help/raster-driver.html \ help/ref-access_log.html \ help/ref-classes-conf.html \ - help/ref-client-conf.html \ help/ref-cupsd-conf.html \ help/ref-cups-files-conf.html \ help/ref-error_log.html \ diff --git a/doc/help/man-cancel.html b/doc/help/man-cancel.html index b21860e03..3c8bf29d0 100644 --- a/doc/help/man-cancel.html +++ b/doc/help/man-cancel.html @@ -11,13 +11,22 @@ cancel - cancel jobs

Synopsis

cancel -[ -E ] [ -U +[ +-E +] [ +-U username -] [ -a ] [ -h +] [ +-a +] [ +-h hostname[:port] -] [ -u +] [ +-u username -] [ -x ] [ +] [ +-x +] [ id ] [ destination @@ -25,45 +34,55 @@ cancel - cancel jobs destination-id ]

Description

-cancel cancels existing print jobs. The -a option will remove -all jobs from the specified destination. +The cancel command cancels print jobs. If no destination or id is specified, the currently printing job on the default destination is canceled.

Options

-The following options are recognized by cancel: +The following options are recognized by cancel:

-E -: -Forces encryption when connecting to the server. -
-U username -: -Specifies the username to use when connecting to the server. -
-a -: -Cancel all jobs on the named destination, or all jobs on all +
-a +: Cancel all jobs on the named destination, or all jobs on all destinations if none is provided. -
-h hostname[:port] -: -Chooses an alternate server. -
-u username -: -Cancels jobs owned by username. -
-x -: -Deletes job data files in addition to canceling. +
-E +: Forces encryption when connecting to the server. +
-h hostname[:port] +: Specifies an alternate server. +
-U username +: Specifies the username to use when connecting to the server. +
-u username +: Cancels jobs owned by username. +
-x +: Deletes job data files in addition to canceling.

Compatibility

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

Conforming To

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

Examples

+Cancel the current print job: +

+
+    cancel
+
+

+Cancel job "myprinter-42": +

+
+    cancel myprinter-42
+
+

+Cancel all jobs: +

+
+    cancel -a
+

Notes

-Administrators wishing to prevent unauthorized cancellation of -jobs via the -u option should require authentication for -Cancel-Jobs operations in cupsd.conf(5). +Administrators wishing to prevent unauthorized cancellation of jobs via the -u option should require authentication for Cancel-Jobs operations in +cupsd.conf(5).

Copyright

-Copyright 2007-2013 by Apple Inc. +Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/man-cups-deviced.html b/doc/help/man-cups-deviced.html deleted file mode 100644 index ee042f768..000000000 --- a/doc/help/man-cups-deviced.html +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - cups-deviced(8) - - -

cups-deviced(8)

Name

-cups-deviced - cups device daemon -

Synopsis

-cups-deviced -request-idlimituser-idoptions -

Description

-cups-deviced polls the backends in -/usr/lib/cups/backend or /usr/libexec/cups/backend (OS X) for a -list of available devices. It is run by cupsd(8) in response to a -CUPS-Get-Devices request. The output format is an IPP -response message. The request-id argument is the request ID -from the original IPP request, typically 1. The limit -argument is the limit value from the original IPP request - 0 -means no limit. The user-id argument is the -requesting-user-name value from the original IPP request. -Finally, the options argument is a space-delimited list of -attributes ("name=value name=value ...") that were passed in -with the request. Currently cups-deviced looks for the -requested-attributes attribute and tailors the output -accordingly. -

Copyright

-Copyright 2007-2013 by Apple Inc. - - - diff --git a/doc/help/man-cups-driverd.html b/doc/help/man-cups-driverd.html deleted file mode 100644 index 5ae8ef5dc..000000000 --- a/doc/help/man-cups-driverd.html +++ /dev/null @@ -1,112 +0,0 @@ - - - - - - cups-driverd(8) - - -

cups-driverd(8)

Name

-cups-driverd - cups driver daemon -

Synopsis

-cups-driverd -cat -ppd-name -
-cups-driverd -list -request_idlimitoptions -

Description

-cups-driverd shows or lists PPD files. It is run in -response to CUPS-Add-Modify-Printer or CUPS-Get-Devices requests. -The first form ("cups-driverd cat ppd-name") writes the named PPD -file to stdout. The output format is an uncompressed PPD file. -

The second form lists the available manufacturers or PPD files to -stdout as indicated by the options argument. The output -format is an IPP response message. The request_id argument -is the request ID from the original IPP request, typically 1. The -limit argument is the limit value from the original IPP -request - 0 means no limit. Finally, the options argument -is a space-delimited list of attributes ("name=value name=value -&...") that were passed in with the request. Currently -cups-driverd looks for the ppd-make and -requested-attributes attributes and tailors the output -accordingly. -

Drivers

-Drivers can be static PPD files under the -/usr/share/cups/model directory or programs under the -/usr/lib/cups/driver or /usr/libexec/cups/driver (OS X) directories. -Static PPD files must conform to the Adobe PPD File Format Specification version -4.3 and may be compressed using the gzip(1) program. Driver -programs must implement the command-line interface shown in the -next section. -

Driver Programs

-Driver programs provide a interface to dynamically-generated PPD -files. The following arguments are currently defined: -

drivername list -: -Lists the supported PPD files to stdout. -
drivername cat ppdname -: -Writes the named PPD file to stdout. -

Driver programs MUST NOT query hardware or make other long-term operations that -would delay the return of a driver list. See the NOTES section below for -specific recommendations. -

Listing Files (drivername list)

-When run with the single argument "list", the program must list -the available PPD files it can generate to stdout using the -following format: -

-    "drivername:ppdname" language "make" "make and model"
-    "drivername:ppdname" language "make" "make and model" "1284 device id"
-    "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)"
-    "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version"
-    "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" "type"
-

Drivername is the name of the driver program. Ppdname -is the name used to select the given driver. Language is -the locale associated with the default language of the PPD file, -typically "en". Make is the Manufacturer name from the PPD -file. Make and model is the NickName name from the PPD -file. 1284 device id is the 1284DeviceId from the PPD file, -if any. (PPD product) is the Product string as it would appear in the PPD -file or from a PostScript query. PostScript version is the PSVersion -string as it would appear in the PPD file or from a PostScript query. Type -is "postscript" for PostScript printers, "pdf" for PDF printers, "raster" for -raster printers, or "fax" for facsimile devices. -

Writing Files (drivername cat ppdname)

-When the driver program is run with the "cat ppdname" arguments, -it must write the named PPD file to stdout, uncompressed. If the -named PPD file does not exist, the driver program must not write -any output to stdout and report the error to stderr instead. -

Driver Error Messages

-Error messages can be relayed back to cupsd by writing them -to stderr. The following prefixes are recognized: -

DEBUG: [drivername] -: -Debugging messages -
ERROR: [drivername] -: -Error messages -
INFO: [drivername] -: -Informational messages -

Notes

-Due to performance considerations, driver programs have been officially -deprecated and should not be used for new development. Currently only the -CUPS web interface and lpinfo(8) command will request lists from all -driver programs. -

Copyright

-Copyright 2007-2013 by Apple Inc. - - - diff --git a/doc/help/man-cupsd.conf.html b/doc/help/man-cupsd.conf.html index c6c71fe62..b48a43aa8 100644 --- a/doc/help/man-cupsd.conf.html +++ b/doc/help/man-cupsd.conf.html @@ -10,33 +10,49 @@

Name

cupsd.conf - server configuration file for cups

Description

-The -cupsd.conf -file configures the CUPS scheduler, -cupsd(8). -It is normally located in the -/etc/cups -directory. Note: File, directory, and user configuration directives that used to be allowed in the cupsd.conf file are now stored in the cups-files.conf(5) instead in order to prevent certain types of privilege escalation attacks. -

Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. The configuration directives are intentionally similar to those used by the popular Apache web server software and are described below. -

Top-level Directives

-The following directives are understood by -cupsd(8). -Consult the online help (http://localhost:631/help) for detailed descriptions: +The cupsd.conf file configures the CUPS scheduler, cupsd(8). It +is normally located in the /etc/cups directory. Note: +File, directory, and user configuration directives that used to be allowed in +the cupsd.conf file are now stored in the cups-files.conf(5) instead +in order to prevent certain types of privilege escalation attacks. +

Each line in the file can be a configuration directive, a blank line, +or a comment. Comment lines start with the # character. The +configuration directives are intentionally similar to those used by the +popular Apache web server software and are described below. +

Directives

+The following directives are understood by cupsd(8). Consult the +on-line help for detailed descriptions:

AccessLogLevel config
AccessLogLevel actions
AccessLogLevel all -: Specifies the logging level for the AccessLog file. +; +Specifies the logging level for the AccessLog file. +
Allow all +
Allow none +
Allow host.domain.com +
Allow *.domain.com +
Allow ip-address +
Allow ip-address/netmask +
Allow ip-address/mm +
Allow @IF(name) +
Allow @LOCAL +: +Allows access from the named hosts or addresses. +
AuthType None +
AuthType Basic +
AuthType BasicDigest +
AuthType Digest +
AuthType Negotiate +: +Specifies the authentication type (None, Basic, BasicDigest, Digest, Negotiate)
AutoPurgeJobs Yes
AutoPurgeJobs No: Specifies whether to purge job history data automatically when it is no longer required for quotas. -
BrowseLocalProtocols [ -: All -] [ -DNSSD -] +
BrowseLocalProtocols [All] [DNSSD] +: Specifies the protocols to use for local printer sharing.
BrowseWebIF Yes
BrowseWebIF No @@ -55,70 +71,124 @@ Specifies the security classification of the server. Specifies whether to allow users to override the classification of individual print jobs.
DefaultAuthType Basic +
DefaultAuthType BasicDigest +
DefaultAuthType Digest
DefaultAuthType Negotiate: Specifies the default type of authentication to use.
DefaultEncryption Never
DefaultEncryption IfRequested
DefaultEncryption Required -: Specifies the type of encryption to use for authenticated requests. +; +Specifies the type of encryption to use for authenticated requests.
DefaultLanguage locale -: Specifies the default language to use for text and web content. +; +Specifies the default language to use for text and web content.
DefaultPaperSize Auto
DefaultPaperSize None
DefaultPaperSize sizename -: Specifies the default paper size for new print queues. "Auto" uses a locale- +; +Specifies the default paper size for new print queues. "Auto" uses a locale- specific default, while "None" specifies there is no default paper size.
DefaultPolicy policy-name -: Specifies the default access policy to use. +; +Specifies the default access policy to use.
DefaultShared Yes
DefaultShared No -: Specifies whether local printers are shared by default. +; +Specifies whether local printers are shared by default. +
Deny all +
Deny none +
Deny host.domain.com +
Deny *.domain.com +
Deny ip-address +
Deny ip-address/netmask +
Deny ip-address/mm +
Deny @IF(name) +
Deny @LOCAL +: +Denies access to the named host or address.
DirtyCleanInterval seconds -: Specifies the delay for updating of configuration and state files. A value of 0 +; +Specifies the delay for updating of configuration and state files. A value of 0 causes the update to happen as soon as possible, typically within a few milliseconds. +
Encryption IfRequested +
Encryption Never +
Encryption Required +: +Specifies the level of encryption that is required for a particular +location.
FilterLimit limit -: Specifies the maximum cost of filters that are run concurrently. +; +Specifies the maximum cost of filters that are run concurrently.
FilterNice nice-value -: Specifies the scheduling priority ("nice" value) of filters that +; +Specifies the scheduling priority ("nice" value) of filters that are run to print a job.
GSSServiceName name -: Specifies the service name when using Kerberos authentication. The default +; +Specifies the service name when using Kerberos authentication. The default service name is "http".
HostNameLookups On
HostNameLookups Off
HostNameLookups Double -: Specifies whether or not to do reverse lookups on client addresses. +; +Specifies whether or not to do reverse lookups on client addresses.
Include filename -: Includes the named file. +; +Includes the named file.
JobKillDelay seconds -: Specifies the number of seconds to wait before killing the filters and backend +; +Specifies the number of seconds to wait before killing the filters and backend associated with a canceled or held job. +
JobPrivateAccess all +
JobPrivateAccess default +
JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+ +: +Specifies an access list for a job's private values. The "default" access list +is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed +or requesting-user-name-denied values. +
JobPrivateValues all +
JobPrivateValues default +
JobPrivateValues none +
JobPrivateValues attribute-name-1 [ ... attribute-name-N ] +: Specifies the list of job values to make private. The "default" values are +"job-name", "job-originating-host-name", and "job-originating-user-name".
JobRetryInterval seconds -: Specifies the interval between retries of jobs in seconds. +; +Specifies the interval between retries of jobs in seconds.
JobRetryLimit count -: Specifies the number of retries that are done for jobs. +; +Specifies the number of retries that are done for jobs.
KeepAlive Yes
KeepAlive No -: Specifies whether to support HTTP keep-alive connections. +; +Specifies whether to support HTTP keep-alive connections.
KeepAliveTimeout seconds -: Specifies the amount of time that connections are kept alive. +; +Specifies the amount of time that connections are kept alive.
<Limit operations> ... </Limit> -: Specifies the IPP operations that are being limited inside a policy. +; +Specifies the IPP operations that are being limited inside a policy.
<Limit methods> ... </Limit>
<LimitExcept methods> ... </LimitExcept> -: Specifies the HTTP methods that are being limited inside a location. +; +Specifies the HTTP methods that are being limited inside a location.
LimitRequestBody -: Specifies the maximum size of any print job request. +; +Specifies the maximum size of any print job request.
Listen ip-address:port
Listen *:port
Listen /path/to/domain/socket -: Listens to the specified address and port or domain socket path. +; +Listens to the specified address and port or domain socket path.
<Location /path> ... </Location> -: Specifies access control for the named location. +; +Specifies access control for the named location.
LogDebugHistory #-messages -: Specifies the number of debugging messages that are logged when an error +; +Specifies the number of debugging messages that are logged when an error occurs in a print job.
LogLevel alert
LogLevel crit @@ -130,75 +200,110 @@ occurs in a print job.
LogLevel none
LogLevel notice
LogLevel warn -: Specifies the logging level for the ErrorLog file. +; +Specifies the logging level for the ErrorLog file.
LogTimeFormat standard
LogTimeFormat usecs -: Specifies the format of the date and time in the log files. +; +Specifies the format of the date and time in the log files.
MaxClients number -: Specifies the maximum number of simultaneous clients to support. +; +Specifies the maximum number of simultaneous clients to support.
MaxClientsPerHost number -: Specifies the maximum number of simultaneous clients to support from a +; +Specifies the maximum number of simultaneous clients to support from a single address.
MaxCopies number -: Specifies the maximum number of copies that a user can print of each job. +; +Specifies the maximum number of copies that a user can print of each job.
MaxHoldTime seconds -: Specifies the maximum time a job may remain in the "indefinite" hold state +; +Specifies the maximum time a job may remain in the "indefinite" hold state before it is canceled. Set to 0 to disable cancellation of held jobs.
MaxJobs number -: Specifies the maximum number of simultaneous jobs to support. +; +Specifies the maximum number of simultaneous jobs to support.
MaxJobsPerPrinter number -: Specifies the maximum number of simultaneous jobs per printer to support. +; +Specifies the maximum number of simultaneous jobs per printer to support.
MaxJobsPerUser number -: Specifies the maximum number of simultaneous jobs per user to support. +; +Specifies the maximum number of simultaneous jobs per user to support.
MaxJobTime seconds -: Specifies the maximum time a job may take to print before it is canceled. The +; +Specifies the maximum time a job may take to print before it is canceled. The default is 10800 seconds (3 hours). Set to 0 to disable cancellation of "stuck" jobs.
MaxLogSize number-bytes -: Specifies the maximum size of the log files before they are +; +Specifies the maximum size of the log files before they are rotated (0 to disable rotation)
MaxRequestSize number-bytes -: Specifies the maximum request/file size in bytes (0 for no limit) +; +Specifies the maximum request/file size in bytes (0 for no limit)
MultipleOperationTimeout seconds -: Specifies the maximum amount of time to allow between files in a multiple file +; +Specifies the maximum amount of time to allow between files in a multiple file print job. +
Order allow,deny +
Order deny,allow +: +Specifies the order of HTTP access control (allow,deny or deny,allow)
PageLogFormat format string -: Specifies the format of page log lines. +; +Specifies the format of page log lines.
PassEnv variable [... variable] -: Passes the specified environment variable(s) to child processes. +; +Passes the specified environment variable(s) to child processes.
<Policy name> ... </Policy> -: Specifies access control for the named policy. +; +Specifies access control for the named policy.
Port number -: Specifies a port number to listen to for HTTP requests. +; +Specifies a port number to listen to for HTTP requests.
PreserveJobFiles Yes
PreserveJobFiles No -: Specifies whether or not to preserve job files after they are printed. +; +Specifies whether or not to preserve job files after they are printed.
PreserveJobHistory Yes
PreserveJobHistory No -: Specifies whether or not to preserve the job history after they are +; +Specifies whether or not to preserve the job history after they are printed.
PrintcapFormat bsd
PrintcapFormat plist
PrintcapFormat solaris -: Specifies the format of the printcap file. +; +Specifies the format of the printcap file.
ReloadTimeout seconds -: Specifies the amount of time to wait for job completion before +; +Specifies the amount of time to wait for job completion before restarting the scheduler. +
Require group group-name-list +
Require user user-name-list +
Require valid-user +: +Specifies that user or group authentication is required.
RIPCache bytes -: Specifies the maximum amount of memory to use when converting images +; +Specifies the maximum amount of memory to use when converting images and PostScript files to bitmaps for a printer.
Satisfy all
Satisfy any -: Specifies whether all or any limits set for a Location must be +; +Specifies whether all or any limits set for a Location must be satisfied to allow access.
ServerAdmin user@domain.com -: Specifies the email address of the server administrator. +; +Specifies the email address of the server administrator.
ServerAlias hostname [... hostname]
ServerAlias * -: Specifies an alternate name that the server is known by. The special name "*" +; +Specifies an alternate name that the server is known by. The special name "*" allows any name to be used.
ServerName hostname-or-ip-address -: Specifies the fully-qualified hostname of the server. +; +Specifies the fully-qualified hostname of the server.
ServerTokens Full
ServerTokens Major
ServerTokens Minimal @@ -206,80 +311,28 @@ allows any name to be used.
ServerTokens None
ServerTokens OS
ServerTokens ProductOnly -: Specifies what information is included in the Server header of HTTP +; +Specifies what information is included in the Server header of HTTP responses.
SetEnv variable value -: Set the specified environment variable to be passed to child processes. +; +Set the specified environment variable to be passed to child processes.
SSLListen -: Listens on the specified address and port for encrypted connections. +; +Listens on the specified address and port for encrypted connections.
SSLPort -: Listens on the specified port for encrypted connections. +; +Listens on the specified port for encrypted connections.
StrictConformance Yes
StrictConformance No -: Specifies whether the scheduler requires clients to strictly adhere to the IPP +; +Specifies whether the scheduler requires clients to strictly adhere to the IPP specifications. The default is No. -
Timeout seconds -: Specifies the HTTP request timeout in seconds. -
WebInterface yes -
WebInterface no -: Specifies whether the web interface is enabled. -

Directives Valid Within Location And Limit Sections

-The following directives may be placed inside Location and Limit sections in the cupsd.conf file: -

Allow all -
Allow none -
Allow host.domain.com -
Allow *.domain.com -
Allow ip-address -
Allow ip-address/netmask -
Allow ip-address/mm -
Allow @IF(name) -
Allow @LOCAL -: Allows access from the named hosts or addresses. -
AuthType None -
AuthType Basic -
AuthType Negotiate -: Specifies the authentication type (None, Basic, or Negotiate) -
Deny all -
Deny none -
Deny host.domain.com -
Deny *.domain.com -
Deny ip-address -
Deny ip-address/netmask -
Deny ip-address/mm -
Deny @IF(name) -
Deny @LOCAL -: Denies access to the named host or address. -
Encryption IfRequested -
Encryption Never -
Encryption Required -: Specifies the level of encryption that is required for a particular -location. -
Order allow,deny -
Order deny,allow -: Specifies the order of HTTP access control (allow,deny or deny,allow) -
Require group group-name-list -
Require user user-name-list -
Require valid-user -: Specifies that user or group authentication is required. -

Directives Valid Within Policy Sections

-The following directives may be placed inside Policy sections in the cupsd.conf file: -

JobPrivateAccess all -
JobPrivateAccess default -
JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+ -: Specifies an access list for a job's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values. -
JobPrivateValues all -
JobPrivateValues default -
JobPrivateValues none -
JobPrivateValues attribute-name-1 [ ... attribute-name-N ] -: Specifies the list of job values to make private. The "default" values are "job-name", "job-originating-host-name", and "job-originating-user-name".
SubscriptionPrivateAccess all
SubscriptionPrivateAccess default
SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM}+ -: Specifies an access list for a subscription's private values. The "default" +; +Specifies an access list for a subscription's private values. The "default" access list is "@OWNER @SYSTEM". "@ACL" maps to the printer's requesting-user-name-allowed or requesting-user-name-denied values.
SubscriptionPrivateValues all @@ -289,12 +342,21 @@ requesting-user-name-allowed or requesting-user-name-denied values.: Specifies the list of job values to make private. The "default" values are "notify-events", "notify-pull-method", "notify-recipient-uri", "notify-subscriber-user-name", and "notify-user-data". +
Timeout seconds +: +Specifies the HTTP request timeout in seconds. +
WebInterface yes +
WebInterface no +: Specifies whether the web interface is enabled.

Copyright

-Copyright © 2007-2014 by Apple Inc. +Copyright 2007-2013 by Apple Inc. diff --git a/doc/help/man-cupsd.html b/doc/help/man-cupsd.html index b2cea2341..3be146048 100644 --- a/doc/help/man-cupsd.html +++ b/doc/help/man-cupsd.html @@ -11,20 +11,9 @@ cupsd - cups scheduler

Synopsis

cupsd -[ --c +[ -c config-file -] [ --f -] [ --F -] [ --h -] [ --l -] [ --t -] +] [ -f ] [ -F ] [ -h ] [ -l ] [ -t ]

Description

cupsd is the scheduler for CUPS. It implements a printing system based upon the Internet Printing Protocol, version 2.1. If no options are specified on the command-line then the default configuration file @@ -32,83 +21,33 @@ is the scheduler for CUPS. It implements a printing system based upon the Intern will be used.

Options

-c config-file +
-c config-file: Uses the named configuration file. -
-f +
-f: Run cupsd in the foreground; the default is to run in the background as a "daemon". -
-F +
-F: Run cupsd in the foreground but detach the process from the controlling terminal and current directory. This is useful for running -cupsd -from -init(8). -
-h +cupsdfrominit(8). +
-h: Shows the program usage. -
-l +
-l: This option is passed to cupsd when it is run from -launchd(8) -or -systemd(8). -
-t +launchd(8). +
-t: Test the configuration file for syntax errors.

Files

-/etc/cups/classes.conf
-/etc/cups/cups-files.conf
-/etc/cups/cupsd.conf
-/usr/share/cups/mime/mime.convs
-/usr/share/cups/mime/mime.types
-/etc/cups/printers.conf
-

Conforming To

-cupsd -implements all of the required IPP/2.1 attributes and operations. It also implements several CUPS-specific administrative operations. -

Examples

-Run -cupsd -in the background with the default configuration file: -

-
-    cupsd
-
-

-Test a configuration file called -test.conf: -

-
-    cupsd -t -c test.conf
-
-

-Run +

Compatibility

cupsd -in the foreground with a test configuration file called -test.conf: -

-
-    cupsd -f -c test.conf
-
-

+implements all of the required IPP/2.1 attributes and operations. It also implements several CUPS-specific administration operations.

Copyright

Copyright © 2007-2014 by Apple Inc. diff --git a/doc/help/ref-client-conf.html b/doc/help/ref-client-conf.html deleted file mode 100644 index 03d1ea04c..000000000 --- a/doc/help/ref-client-conf.html +++ /dev/null @@ -1,94 +0,0 @@ - - - - client.conf - - - - -

client.conf

- -

The /etc/cups/client.conf and -~/.cups/client.conf files contain up to two directives -that determine how the client behaves. Each directive is listed -on a line by itself followed by its value. Comments are -introduced using the number sign ("#") character at the beginning -of a line.

- -

Encryption

- -

Examples

- -

-Encryption Never
-Encryption IfRequested
-Encryption Required
-Encryption Always
-

- -

Description

- -

The Encryption directive specifies the default -encryption settings for the client.

- -

The default setting is IfRequested.

- - -

CUPS 1.6/OS X 10.8GSSServiceName

- -

Examples

- -

-GSSServiceName http
-GSSServiceName ipp
-

- -

Description

- -

The GSSServiceName directive sets the Kerberos service name to use. The default is http for compatibility with Microsoft Windows.

- - -

ServerName

- -

Examples

- -

-ServerName foo.bar.com
-ServerName 11.22.33.44
-ServerName foo.bar.com:8631
-CUPS 1.6ServerName foo.bar.com/version=1.1
-CUPS 1.6ServerName foo.bar.com:8631/version=1.1
-

- -

Description

- -

The ServerName directive specifies sets the remote server that is to be used for all client operations. That is, it redirects all client requests to the remote server.

- -

The default port number is 631 but can be overridden by adding a colon followed by the desired port number to the value.

- -

By default, CUPS 1.6 and later use IPP/2.0 to communicate with the server. Add "/version=1.1" to force IPP/1.1 which is required for CUPS 1.3.12 and earlier.

- -

The default is to use the local server ("localhost") or domain socket, if so configured.

- -

Note: -
Only one ServerName directive may appear. If multiple names are -present, only the last one is used. This directive is not supported on OS X 10.7 or later.
-

- - -

CUPS 1.6/OS X 10.8User

- -

Examples

- -

-User joe
-User bob
-

- -

Description

- -

The User directive sets the user name to use. The default is the username associated with the current login.

- - - - diff --git a/man/Makefile b/man/Makefile index 927454a50..b85e46bef 100644 --- a/man/Makefile +++ b/man/Makefile @@ -57,11 +57,10 @@ MAN8 = cupsaccept.$(MAN8EXT) \ cupsaddsmb.$(MAN8EXT) \ cupsctl.$(MAN8EXT) \ cupsfilter.$(MAN8EXT) \ - cups-deviced.$(MAN8EXT) \ - cups-driverd.$(MAN8EXT) \ cups-lpd.$(MAN8EXT) \ cups-snmp.$(MAN8EXT) \ cupsd.$(MAN8EXT) \ + cupsd-helper.$(MAN8EXT) \ cupsenable.$(MAN8EXT) \ lpadmin.$(MAN8EXT) \ lpinfo.$(MAN8EXT) \ diff --git a/man/cancel.man b/man/cancel.man index 15adcb22d..f1d068e15 100644 --- a/man/cancel.man +++ b/man/cancel.man @@ -1,79 +1,98 @@ .\" .\" "$Id$" .\" -.\" cancel man page for CUPS. +.\" cancel 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 cancel 1 "CUPS" "21 January 2013" "Apple Inc." +.TH cancel 1 "CUPS" "15 April 2014" "Apple Inc." .SH NAME -cancel - cancel jobs +cancel \- cancel jobs .SH SYNOPSIS .B cancel -[ -E ] [ -U +[ +.I \-E +] [ +.I \-U .I username -] [ -a ] [ -h +] [ +.I \-a +] [ +.I \-h .I hostname[:port] -] [ -u +] [ +.I \-u .I username -] [ -x ] [ +] [ +.I \-x +] [ .I id ] [ .I destination ] [ -.I destination-id +.I destination\-id ] .SH DESCRIPTION -\fIcancel\fR cancels existing print jobs. The \fI-a\fR option will remove -all jobs from the specified destination. +The \fBcancel\fR command cancels print jobs. If no \fIdestination\fR or \fIid\fR is specified, the currently printing job on the default destination is canceled. .SH OPTIONS -The following options are recognized by \fIcancel\fR: -.TP 5 --E -.br -Forces encryption when connecting to the server. -.TP 5 --U username -.br -Specifies the username to use when connecting to the server. +The following options are recognized by \fBcancel\fR: .TP 5 --a -.br +.B \-a Cancel all jobs on the named destination, or all jobs on all destinations if none is provided. .TP 5 --h hostname[:port] -.br -Chooses an alternate server. +.B \-E +Forces encryption when connecting to the server. +.TP 5 +\fB\-h \fIhostname\fR[\fI:port\fR] +Specifies an alternate server. +.TP 5 +\fB\-U \fIusername\fR +Specifies the username to use when connecting to the server. .TP 5 --u username -.br +\fB\-u \fIusername\fR Cancels jobs owned by \fIusername\fR. .TP 5 --x -.br +.B \-x Deletes job data files in addition to canceling. -.SH COMPATIBILITY -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. +.SH CONFORMING TO +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. +.SH EXAMPLES +Cancel the current print job: +.nf + + cancel + +.fi +Cancel job "myprinter-42": +.nf + + cancel myprinter\-42 + +.fi +Cancel all jobs: +.nf + + cancel \-a +.fi .SH NOTES -Administrators wishing to prevent unauthorized cancellation of -jobs via the \fI-u\fR option should require authentication for -Cancel-Jobs operations in \fIcupsd.conf(5)\fR. +Administrators wishing to prevent unauthorized cancellation of jobs via the \fI\-u\fR option should require authentication for Cancel-Jobs operations in +.BR cupsd.conf (5). .SH SEE ALSO -\fIlp(1)\fR, \fIlpmove(8)\fR, \fIlpstat(1)\fR, -.br -http://localhost:631/help +.BR cupsd.conf (5), +.BR lp (1), +.BR lpmove (8), +.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/classes.conf.man b/man/classes.conf.man index 8a40a7d51..2f4a4aebc 100644 --- a/man/classes.conf.man +++ b/man/classes.conf.man @@ -1,110 +1,36 @@ .\" .\" "$Id$" .\" -.\" classes.conf man page for CUPS. +.\" classes.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 classes.conf 5 "CUPS" "29 April 2009" "Apple Inc." +.TH classes.conf 5 "CUPS" "15 April 2014" "Apple Inc." .SH NAME classes.conf \- class configuration file for cups .SH DESCRIPTION -The \fIclasses.conf\fR file defines the local printer classes that are -available. It is normally located in the \fI/etc/cups\fR directory and -is generated automatically by the \fIcupsd(8)\fR program when printer -classes are added or deleted. -.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 -.TP 5 - ... -.br -Defines a specific printer class. -.TP 5 - ... -.br -Defines a default printer class. -.TP 5 -Accepting Yes -.TP 5 -Accepting No -.br -Specifies whether the printer is accepting new jobs. -.TP 5 -AllowUser [ user @group ... ] -.br -Allows specific users and groups to print to the printer. -.TP 5 -DenyUser [ user @group ... ] -.br -Prevents specific users and groups from printing to the printer. -.TP 5 -Info text -.br -Specifies human-readable text describing the printer. -.TP 5 -JobSheets banner banner -.br -Specifies the banner pages to use for the printer. -.TP 5 -KLimit number -.br -Specifies the job-k-limit value for the printer. -.TP 5 -Location text -.br -Specifies human-readable text describing the location of the printer. -.TP 5 -OpPolicy name -.br -Specifies the operation policy for the printer. -.TP 5 -PageLimit number -.br -Specifies the job-page-limit value for the printer. -.TP 5 -Printer -.br -Specifies a printer that is a member of the printer class. -.TP 5 -QuotaPeriod seconds -.br -Specifies the job-quota-period value for the printer. -.TP 5 -Shared Yes -.TP 5 -Shared No -.br -Specifies whether the printer is shared. -.TP 5 -State idle -.TP 5 -State stopped -.br -Specifies the initial state of the printer (Idle or Stopped) -.TP 5 -StateMessage text -.br -Specifies the message associated with the state. -.TP 5 -StateTime seconds -.br -Specifies the date/time associated with the state. +The \fBclasses.conf\fR file defines the local printer classes that are available. It is normally located in the \fI/etc/cups\fR directory and is maintained by the +.BR cupsd (8) +program. This file is not intended to be edited or managed manually. +.SH NOTES +The name, location, and format of this file are an implementation detail that will change in future releases of CUPS. .SH SEE ALSO -\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), +.BR cupsd.conf (5), +.BR mime.convs (5), +.BR mime.types (5), +.BR printers.conf (5), +.BR subscriptions.conf (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/client.conf.man.in b/man/client.conf.man.in index a078ac9df..4930e12c2 100644 --- a/man/client.conf.man.in +++ b/man/client.conf.man.in @@ -1,65 +1,58 @@ .\" .\" "$Id$" .\" -.\" client.conf man page for CUPS. +.\" client.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 client.conf 5 "CUPS" "8 July 2013" "Apple Inc." +.TH client.conf 5 "CUPS" "15 April 2014" "Apple Inc." .SH NAME -client.conf \- client configuration file for cups +client.conf \- client configuration file for cups (deprecated) .SH DESCRIPTION -The \fIclient.conf\fR file configures the CUPS client and is -normally located in the \fI/etc/cups\fR or \fI~/.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. -.SH DIRECTIVES -The following directives are understood by the client. Consult the -on-line help for detailed descriptions: +The \fBclient.conf\fR file configures the CUPS client and is normally located in the \fI/etc/cups\fR and/or \fI~/.cups\fR directories. +Each line in the file can be a configuration directive, a blank line, or a comment. Comment lines start with the # character. +.LP +\fBNote:\fR Starting with OS X 10.7, this file is only used by command-line and X11 applications. +The \fBServerName\fR directive is not supported on OS X at all. +.SS DIRECTIVES +The following directives are understood by the client. Consult the online help for detailed descriptions: .TP 5 -Encryption IfRequested +\fBEncryption IfRequested\fR .TP 5 -Encryption Never +\fBEncryption Never\fR .TP 5 -Encryption Required -.br -Specifies the level of encryption that is required for a particular -location. +\fBEncryption Required\fR +Specifies the level of encryption that should be used. .TP 5 -GSSServiceName name -Specifies the Kerberos service name that is used for authentication, typically -"host", "http", or "ipp". CUPS adds the remote hostname -("name@server.example.com") for you. The default name is -"http". +\fBGSSServiceName \fIname\fR +Specifies the Kerberos service name that is used for authentication, typically "host", "http", or "ipp". +CUPS adds the remote hostname ("name@server.example.com") for you. The default name is "http". .TP 5 -ServerName hostname-or-ip-address[:port] +\fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR] .TP 5 -ServerName /domain/socket -.br -Specifies the address and optionally the port to use when connecting to the -server. \fBNote: Not supported on OS X 10.7 or later.\fR +\fBServerName \fI/domain/socket\fR +Specifies the address and optionally the port to use when connecting to the server. +\fBNote: This directive it not supported on OS X 10.7 or later.\fR .TP 5 -ServerName hostname-or-ip-address[:port]/version=1.1 -.br -Specifies the address and optionally the port to use when connecting to a -server running CUPS 1.3.12 and earlier. \fBNote: Not supported on OS X 10.7 or -later.\fR +\fBServerName \fIhostname-or-ip-address\fR[\fI:port\fR]\fB/version=1.1\fR +Specifies the address and optionally the port to use when connecting to a server running CUPS 1.3.12 and earlier. .TP 5 -User name -.br +\fBUser \fIname\fR Specifies the default user name to use for requests. +.SH NOTES +The \fBclient.conf\fR file is deprecated and will no longer be supported in a future version of CUPS. .SH SEE ALSO -http://localhost:631/help +.BR cups (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/cups-config.man b/man/cups-config.man index 69bad3c2e..c020d4acc 100644 --- a/man/cups-config.man +++ b/man/cups-config.man @@ -1,117 +1,116 @@ .\" .\" "$Id$" .\" -.\" cups-config man page for CUPS. +.\" cups-config 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 cups-config 1 "CUPS" "23 October 2008" "Apple Inc." +.TH cups-config 1 "CUPS" "15 April 2014" "Apple Inc." .SH NAME -cups-config \- get cups api, compiler, directory, and link information. +cups\-config \- get cups api, compiler, directory, and link information. .SH SYNOPSIS -.B cups-config ---api-version +.B cups\-config +.I \-\-api\-version .br -.B cups-config ---build +.B cups\-config +.I \-\-build .br -.B cups-config ---cflags +.B cups\-config +.I \-\-cflags .br -.B cups-config ---datadir +.B cups\-config +.I \-\-datadir .br -.B cups-config ---help +.B cups\-config +.I \-\-help .br -.B cups-config ---ldflags +.B cups\-config +.I \-\-ldflags .br -.B cups-config +.B cups\-config [ -.I --image +.I \-\-image ] [ -.I --static -] --libs +.I \-\-static +] +.I \-\-libs .br -.B cups-config ---serverbin +.B cups\-config +.I \-\-serverbin .br -.B cups-config ---serverroot +.B cups\-config +.I \-\-serverroot .br .B cups-config ---version +.I \-\-version .br .SH DESCRIPTION -\fBcups-config\fR is the CUPS program configuration utility. It should be -used by application developers to determine the necessary command-line -options for the compiler and linker, as well as determining installation -directories for filters, configuration files, and drivers. +The \fBcups-config\fR command allows application developers to determine the necessary command-line options for the compiler and linker, as well as the installation directories for filters, configuration files, and drivers. +All values are reported to the standard output. .SH OPTIONS +The \fBcups-config\fR command accepts the following command-line options: .TP 5 ---api-version -.br -Displays the current API version (major.minor). +.B \-\-api-version +Reports the current API version (major.minor). .TP 5 ---build -.br -Displays a system-specific build number. +.B \-\-build +Reports a system-specific build number. .TP 5 ---cflags -.br -Displays the necessary compiler options. +.B \-\-cflags +Reports the necessary compiler options. .TP 5 ---datadir -.br -Displays the default CUPS data directory. +.B \-\-datadir +Reports the default CUPS data directory. .TP 5 ---help -.br -Displays the program usage message. +.B \-\-help +Reports the program usage message. .TP 5 ---image -.br -When used with \fI--libs\fR, adds the CUPS imaging library to the -list of displayed libraries. +.B \-\-image +When used with \fI\-\-libs\fR, adds the CUPS imaging library to the +list of libraries. .TP 5 ---ldflags -.br -Displays the necessary linker options. +.B \-\-ldflags +Reports the necessary linker options. .TP 5 ---libs -.br -Displays the necessary librarys to link to. +.B \-\-libs +Reports the necessary libraries to link to. .TP 5 ---serverbin -.br -Displays the default CUPS binary directory, -where filters and backends are stored. +.B \-\-serverbin +Reports the default CUPS binary directory, where filters and backends are stored. .TP 5 ---serverroot -.br -Displays the default CUPS configuration file directory. +.B \-\-serverroot +Reports the default CUPS configuration file directory. .TP 5 ---static -.br -When used with \fI--libs\fR, shows the static libraries instead -of the default (shared) libraries. +.B \-\-static +When used with \fI\-\-libs\fR, reports the static libraries instead of the default (shared) libraries. .TP 5 ---version -.br -Displays the full version number of the CUPS installation -(major.minor.patch). +.B \-\-version +Reports the full version number of the CUPS installation (major.minor.patch). +.SH EXAMPLES +Show the currently installed version of CUPS: +.nf + + cups-config \-\-version + +.fi +Compile a simple one-file CUPS filter: +.nf + + cc `cups\-config \-\-cflags \-\-ldflags` \-o filter filter.c \\ + `cups\-config \-\-libs` +.fi .SH SEE ALSO -http://localhost:631/help +.BR cups (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/cups-deviced.man.in b/man/cups-deviced.man.in deleted file mode 100644 index 4aa8f432a..000000000 --- a/man/cups-deviced.man.in +++ /dev/null @@ -1,44 +0,0 @@ -.\" -.\" "$Id$" -.\" -.\" cups-deviced man page for CUPS. -.\" -.\" Copyright 2007-2013 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/". -.\" -.TH cups-deviced 8 "CUPS" "8 July 2013" "Apple Inc." -.SH NAME -cups-deviced \- cups device daemon -.SH SYNOPSIS -.B cups-deviced -.I request-id limit user-id options -.SH DESCRIPTION -\fIcups-deviced\fR polls the backends in -\fI/usr/lib/cups/backend\fR or \fI/usr/libexec/cups/backend\fR (OS X) for a -list of available devices. It is run by \fIcupsd(8)\fR in response to a -\fICUPS-Get-Devices\fR request. The output format is an IPP -response message. The \fIrequest-id\fR argument is the request ID -from the original IPP request, typically 1. The \fIlimit\fR -argument is the limit value from the original IPP request - 0 -means no limit. The \fIuser-id\fR argument is the -requesting-user-name value from the original IPP request. -Finally, the \fIoptions\fR argument is a space-delimited list of -attributes ("name=value name=value \...") that were passed in -with the request. Currently \fIcups-deviced\fR looks for the -\fIrequested-attributes\fR attribute and tailors the output -accordingly. -.SH SEE ALSO -backend(7), cupsd(8), cupsd.conf(5), -.br -http://localhost:631/help -.SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. -.\" -.\" End of "$Id$". -.\" diff --git a/man/cups-driverd.man.in b/man/cups-driverd.man.in deleted file mode 100644 index 3cb3fef00..000000000 --- a/man/cups-driverd.man.in +++ /dev/null @@ -1,122 +0,0 @@ -.\" -.\" "$Id$" -.\" -.\" cups-driverd man page for CUPS. -.\" -.\" Copyright 2007-2013 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/". -.\" -.TH cups-driverd 8 "CUPS" "8 July 2013" "Apple Inc." -.SH NAME -cups-driverd \- cups driver daemon -.SH SYNOPSIS -.B cups-driverd -cat -.I ppd-name -.br -.B cups-driverd -list -.I request_id limit options -.SH DESCRIPTION -\fIcups-driverd\fR shows or lists PPD files. It is run in -response to CUPS-Add-Modify-Printer or CUPS-Get-Devices requests. -The first form ("cups-driverd cat ppd-name") writes the named PPD -file to stdout. The output format is an uncompressed PPD file. -.LP -The second form lists the available manufacturers or PPD files to -stdout as indicated by the \fIoptions\fR argument. The output -format is an IPP response message. The \fIrequest_id\fR argument -is the request ID from the original IPP request, typically 1. The -\fIlimit\fR argument is the limit value from the original IPP -request - 0 means no limit. Finally, the \fIoptions\fR argument -is a space-delimited list of attributes ("name=value name=value -\&...") that were passed in with the request. Currently -\fIcups-driverd\fR looks for the \fIppd-make\fR and -\fIrequested-attributes\fR attributes and tailors the output -accordingly. -.SH DRIVERS -Drivers can be static PPD files under the -\fI/usr/share/cups/model\fR directory or programs under the -\fI/usr/lib/cups/driver\fR or \fI/usr/libexec/cups/driver\fR (OS X) directories. -Static PPD files must conform to the Adobe PPD File Format Specification version -4.3 and may be compressed using the \fIgzip(1)\fR program. Driver -programs must implement the command-line interface shown in the -next section. -.SS DRIVER PROGRAMS -Driver programs provide a interface to dynamically-generated PPD -files. The following arguments are currently defined: -.TP 5 -drivername list -.br -Lists the supported PPD files to stdout. -.TP 5 -drivername cat ppdname -.br -Writes the named PPD file to stdout. -.PP -Driver programs MUST NOT query hardware or make other long-term operations that -would delay the return of a driver list. See the NOTES section below for -specific recommendations. -.SS LISTING FILES (drivername list) -When run with the single argument "list", the program must list -the available PPD files it can generate to stdout using the -following format: -.nf - "drivername:ppdname" language "make" "make and model" - "drivername:ppdname" language "make" "make and model" "1284 device id" - "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" - "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" - "drivername:ppdname" language "make" "make and model" "1284 device id" "(PPD product)" "PostScript version" "type" -.fi -.LP -\fIDrivername\fR is the name of the driver program. \fIPpdname\fR -is the name used to select the given driver. \fILanguage\fR is -the locale associated with the default language of the PPD file, -typically "en". \fIMake\fR is the Manufacturer name from the PPD -file. \fIMake and model\fR is the NickName name from the PPD -file. \fI1284 device id\fR is the 1284DeviceId from the PPD file, -if any. \fI(PPD product)\fR is the Product string as it would appear in the PPD -file or from a PostScript query. \fIPostScript version\fR is the PSVersion -string as it would appear in the PPD file or from a PostScript query. \fIType\fR -is "postscript" for PostScript printers, "pdf" for PDF printers, "raster" for -raster printers, or "fax" for facsimile devices. -.SS WRITING FILES (drivername cat ppdname) -When the driver program is run with the "cat ppdname" arguments, -it must write the named PPD file to stdout, uncompressed. If the -named PPD file does not exist, the driver program must not write -any output to stdout and report the error to stderr instead. -.SS DRIVER ERROR MESSAGES -Error messages can be relayed back to \fIcupsd\fR by writing them -to stderr. The following prefixes are recognized: -.TP 5 -DEBUG: [drivername] -.br -Debugging messages -.TP 5 -ERROR: [drivername] -.br -Error messages -.TP 5 -INFO: [drivername] -.br -Informational messages -.SH NOTES -Due to performance considerations, driver programs have been officially -deprecated and should not be used for new development. Currently only the -CUPS web interface and \fIlpinfo(8)\fR command will request lists from all -driver programs. -.SH SEE ALSO -cupsd(8), cupsd.conf(5), cupstestppd(1), lpinfo(8), -.br -http://localhost:631/help -.SH COPYRIGHT -Copyright 2007-2013 by Apple Inc. -.\" -.\" End of "$Id$". -.\" diff --git a/man/cupsd-helper.man b/man/cupsd-helper.man new file mode 100644 index 000000000..7d2cfefea --- /dev/null +++ b/man/cupsd-helper.man @@ -0,0 +1,94 @@ +.\" +.\" "$Id$" +.\" +.\" cupsd-helper man page for CUPS. +.\" +.\" 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/". +.\" +.TH cupsd-helper 8 "CUPS" "15 April 2014" "Apple Inc." +.SH NAME +cupsd\-helper \- cupsd helper programs +.SH SYNOPSIS +.B cups\-deviced +.I request-id +.I limit +.I user-id +.I options +.br +.B cups\-driverd +.B cat +.I ppd-name +.br +.B cups\-driverd +.B list +.I request_id +.I limit +.I options +.br +.B cups\-exec +.I sandbox-profile +[ +.I \-g +.I group-id +] [ +.I \-n +.I nice-value +] [ +.I \-u +.I user-id +] +.I /path/to/program +.I argv0 +.I ... +.I argvN +.SH DESCRIPTION +The \fBcupsd\-helper\fR programs perform long-running operations on behalf of the scheduler, +.BR cupsd (8). +The \fBcups-deviced\fR helper program runs each CUPS +.BR backend (7) +with no arguments in order to discover the available printers. +.LP +The \fBcups-driverd\fR helper program lists all available printer drivers, a subset of "matching" printer drivers, or a copy of a specific driver PPD file. +.LP +The \fBcups-exec\fR helper program runs backends, filters, and other programs. On OS X these programs are run in a secure sandbox. +.SH FILES +The \fBcups-driverd\fR program looks for PPD and driver information files in the following directories: +.nf + + \fI/Library/Printers\fR + \fI/opt/share/ppd\fR + \fI/System/Library/Printers\fR + \fI/usr/local/share/ppd\fR + \fI/usr/share/cups/drv\fR + \fI/usr/share/cups/model\fR + \fI/usr/share/ppd\fR +.fi +.LP +PPD files can be compressed using the +.BR gzip (1) +program or placed in compressed +.BR tar (1) +archives to further reduce their size. +.LP +Driver information files must conform to the format defined in +.BR ppdcfile (5). +.SH SEE ALSO +.BR backend (7), +.BR cups (1), +.BR cupsd (8), +.BR cupsd.conf (5), +.BR filter (7), +.BR ppdcfile (5), +CUPS Online Help (http://localhost:631/help) +.SH COPYRIGHT +Copyright \[co] 2007-2014 by Apple Inc. +.\" +.\" End of "$Id$". +.\" diff --git a/man/printers.conf.man b/man/printers.conf.man index 02487daaa..93786dacf 100644 --- a/man/printers.conf.man +++ b/man/printers.conf.man @@ -1,124 +1,36 @@ .\" .\" "$Id$" .\" -.\" printers.conf man page for CUPS. +.\" printers.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 printers.conf 5 "CUPS" "29 April 2009" "Apple Inc." +.TH printers.conf 5 "CUPS" "15 April 2014" "Apple Inc." .SH NAME printers.conf \- printer configuration file for cups .SH DESCRIPTION -The \fIprinters.conf\fR file defines the local printers that are -available. It is normally located in the \fI/etc/cups\fR directory and -is generated automatically by the \fIcupsd(8)\fR program when printers -are added or deleted. -.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 -.TP 5 - ... -.br -Defines a specific printer. -.TP 5 - ... -.br -Defines a default printer. -.TP 5 -Accepting Yes -.TP 5 -Accepting No -.br -Specifies whether the printer is accepting new jobs. -.TP 5 -AllowUser [ user @group ... ] -.br -Allows specific users and groups to print to the printer. -.TP 5 -DenyUser [ user @group ... ] -.br -Prevents specific users and groups from printing to the printer. -.TP 5 -DeviceURI uri -.br -Specifies the device URI for a printer. -.TP 5 -ErrorPolicy abort-job -.TP 5 -ErrorPolicy retry-current-job -.TP 5 -ErrorPolicy retry-job -.TP 5 -ErrorPolicy stop-printer -.br -Specifies the error policy for the printer. -.TP 5 -Info text -.br -Specifies human-readable text describing the printer. -.TP 5 -JobSheets banner banner -.br -Specifies the banner pages to use for the printer. -.TP 5 -KLimit number -.br -Specifies the job-k-limit value for the printer. -.TP 5 -Location text -.br -Specifies human-readable text describing the location of the printer. -.TP 5 -OpPolicy name -.br -Specifies the operation policy for the printer. -.TP 5 -PageLimit number -.br -Specifies the job-page-limit value for the printer. -.TP 5 -PortMonitor monitor -.br -Specifies the port monitor for a printer. -.TP 5 -QuotaPeriod seconds -.br -Specifies the job-quota-period value for the printer. -.TP 5 -Shared Yes -.TP 5 -Shared No -.br -Specifies whether the printer is shared. -.TP 5 -State idle -.TP 5 -State stopped -.br -Specifies the initial state of the printer (Idle or Stopped) -.TP 5 -StateMessage text -.br -Specifies the message associated with the state. -.TP 5 -StateTime seconds -.br -Specifies the date/time associated with the state. +The \fBprinters.conf\fR file defines the local printers that are available. It is normally located in the \fI/etc/cups\fR directory and is maintained by the +.BR cupsd (8) +program. This file is not intended to be edited or managed manually. +.SH NOTES +The name, location, and format of this file are an implementation detail that will change in future releases of CUPS. .SH SEE ALSO -\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, -\fImime.convs(5)\fR, \fImime.types(5)\fR, -.br -http://localhost:631/help +.BR classes.conf (5), +.BR cupsd (8), +.BR cupsd.conf (5), +.BR mime.convs (5), +.BR mime.types (5), +.BR subscriptions.conf (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/subscriptions.conf.man b/man/subscriptions.conf.man index 1c5277a50..3e942205e 100644 --- a/man/subscriptions.conf.man +++ b/man/subscriptions.conf.man @@ -1,89 +1,36 @@ .\" .\" "$Id$" .\" -.\" subscriptions.conf man page for CUPS. +.\" subscriptions.conf man page for CUPS. .\" -.\" Copyright 2007-2013 by Apple Inc. -.\" Copyright 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 subscriptions.conf 5 "CUPS" "30 April 2006" "Apple Inc." +.TH subscriptions.conf 5 "CUPS" "15 April 2014" "Apple Inc." .SH NAME -subscriptions.conf \- subscriptions file for cups +subscriptions.conf \- subscription configuration file for cups .SH DESCRIPTION -The \fIsubscriptions.conf\fR file defines the local subscriptions -that are active. It is normally located in the \fI/etc/cups\fR -directory and is generated automatically by the \fIcupsd(8)\fR -program when subscriptions are created, renewed, or cancelled. -.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 -.TP 5 - ... -.br -Defines a subscription. -.TP 5 -Events name [ ... name ] -.br -Specifies the events that are subscribed. -.TP 5 -ExpirationTime unix-time -.br -Specifies the expiration time of a subscription as a UNIX time -value in seconds since January 1st, 1970. -.TP 5 -Interval seconds -.br -Specifies the preferred time interval for event notifications in -seconds. -.TP 5 -JobId job-id -.br -Specifies the job ID associated with the subscription. -.TP 5 -LeaseDuration seconds -.br -Specifies the number of seconds that the subscription is valid -for. If 0, the subscription does not expire. -.TP 5 -NextEventId number -.br -Specifies the next notify-sequence-number to use for the -subscription. -.TP 5 -NextSubscriptionId number -.br -Specifies the next subscription-id to use. -.TP 5 -Owner username -.br -Specifies the user that owns the subscription. -.TP 5 -PrinterName printername -.br -Specifies the printer or class associated with the subscription. -.TP 5 -Recipient uri -.br -Specifies the notify-recipient-uri value for push-type notifications. -.TP 5 -UserData hex-escaped-data -.br -Specifies user data to be included in event notifications. This -is typically the "from" address in mailto: notifications. +The \fBsubscriptions.conf\fR file defines the local event notification subscriptions that are active. It is normally located in the \fI/etc/cups\fR directory and is maintained by the +.BR cupsd (8) +program. This file is not intended to be edited or managed manually. +.SH NOTES +The name, location, and format of this file are an implementation detail that will change in future releases of CUPS. .SH SEE ALSO -\fIclasses.conf(5)\fR, \fIcupsd(8)\fR, \fIcupsd.conf(5)\fR, -\fImime.convs(5)\fR, \fImime.types(5)\fR, \fRprinters.conf(5)\fR -.br -http://localhost:631/help +.BR classes.conf (5), +.BR cupsd (8), +.BR cupsd.conf (5), +.BR mime.convs (5), +.BR mime.types (5), +.BR printers.conf (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/scheduler/cups-exec.c b/scheduler/cups-exec.c index 29ded7f72..c77445056 100644 --- a/scheduler/cups-exec.c +++ b/scheduler/cups-exec.c @@ -13,7 +13,7 @@ * * Usage: * - * cups-exec /path/to/profile UID GID NICE /path/to/program argv0 argv1 ... argvN + * cups-exec /path/to/profile [-u UID] [-g GID] [-n NICE] /path/to/program argv0 argv1 ... argvN */ /* -- 2.39.2