1cupsd.conf(5)                     Apple Inc.                     cupsd.conf(5)
2
3
4

NAME

6       cupsd.conf - server configuration file for cups
7

DESCRIPTION

9       The  cupsd.conf  file  configures  the CUPS scheduler, cupsd(8).  It is
10       normally located in the /etc/cups directory.  Each line in the file can
11       be  a  configuration directive, a blank line, or a comment.  Configura‐
12       tion directives typically consist of a name and  zero  or  more  values
13       separated  by  whitespace.  The configuration directive name and values
14       are case-insensitive.  Comment lines start with the # character.
15
16   TOP-LEVEL DIRECTIVES
17       The following top-level directives are understood by cupsd(8):
18
19       AccessLogLevel config
20
21       AccessLogLevel actions
22
23       AccessLogLevel all
24            Specifies the logging level for the AccessLog file.  The  "config"
25            level  logs when printers and classes are added, deleted, or modi‐
26            fied and when configuration files are accessed  or  updated.   The
27            "actions"   level  logs  when  print  jobs  are  submitted,  held,
28            released, modified, or canceled, and any  of  the  conditions  for
29            "config".   The "all" level logs all requests.  The default access
30            log level is "actions".
31
32       AutoPurgeJobs Yes
33
34       AutoPurgeJobs No
35            Specifies whether to purge job history data automatically when  it
36            is no longer required for quotas.  The default is "No".
37
38       BrowseDNSSDSubTypes_subtype[,...]
39            Specifies a list of Bonjour sub-types to advertise for each shared
40            printer.  For  example,  "BrowseDNSSDSubTypes  _cups,_print"  will
41            tell network clients that both CUPS sharing and IPP Everywhere are
42            supported.  The default is "_cups" which is necessary for  printer
43            sharing to work between systems using CUPS.
44
45       BrowseLocalProtocols all
46
47       BrowseLocalProtocols dnssd
48
49       BrowseLocalProtocols none
50            Specifies  which  protocols to use for local printer sharing.  The
51            default is "dnssd" on systems that support Bonjour and "none" oth‐
52            erwise.
53
54       BrowseWebIF Yes
55
56       BrowseWebIF No
57            Specifies  whether  the  CUPS  web  interface  is advertised.  The
58            default is "No".
59
60       Browsing Yes
61
62       Browsing No
63            Specifies whether shared printers are advertised.  The default  is
64            "No".
65
66       DefaultAuthType Basic
67
68       DefaultAuthType Negotiate
69            Specifies  the default type of authentication to use.  The default
70            is "Basic".
71
72       DefaultEncryption Never
73
74       DefaultEncryption IfRequested
75
76       DefaultEncryption Required
77            Specifies  whether  encryption  will  be  used  for  authenticated
78            requests.  The default is "Required".
79
80       DefaultLanguage locale
81            Specifies  the  default  language to use for text and web content.
82            The default is "en".
83
84       DefaultPaperSize Auto
85
86       DefaultPaperSize None
87
88       DefaultPaperSize sizename
89            Specifies the default paper size for new print queues. "Auto" uses
90            a  locale-specific  default,  while  "None"  specifies there is no
91            default paper size.  Specific size names are typically "Letter" or
92            "A4".  The default is "Auto".
93
94       DefaultPolicy policy-name
95            Specifies  the  default  access policy to use.  The default access
96            policy is "default".
97
98       DefaultShared Yes
99
100       DefaultShared No
101            Specifies whether local  printers  are  shared  by  default.   The
102            default is "Yes".
103
104       DirtyCleanInterval seconds
105            Specifies the delay for updating of configuration and state files.
106            A value of 0 causes the update to happen as soon as possible, typ‐
107            ically within a few milliseconds.  The default value is "30".
108
109       DNSSDHostNamehostname.example.com
110            Specifies  the  fully-qualified domain name for the server that is
111            used for Bonjour sharing.  The default is typically  the  server's
112            ".local" hostname.
113
114       ErrorPolicy abort-job
115            Specifies  that  a  failed print job should be aborted (discarded)
116            unless otherwise specified for the printer.
117
118       ErrorPolicy retry-current-job
119            Specifies that a failed print job should  be  retried  immediately
120            unless otherwise specified for the printer.
121
122       ErrorPolicy retry-job
123            Specifies  that  a  failed  print job should be retried at a later
124            time unless otherwise specified for the printer.
125
126       ErrorPolicy stop-printer
127            Specifies that a failed print job should stop the  printer  unless
128            otherwise specified for the printer. The 'stop-printer' error pol‐
129            icy is the default.
130
131       FilterLimit limit
132            Specifies the maximum cost of filters that are  run  concurrently,
133            which can be used to minimize disk, memory, and CPU resource prob‐
134            lems.  A limit of 0 disables filter limiting.  An average print to
135            a  non-PostScript  printer  needs  a filter limit of about 200.  A
136            PostScript printer needs about half that (100).  Setting the limit
137            below  these  thresholds  will  effectively limit the scheduler to
138            printing a single job at any time.  The default limit is "0".
139
140       FilterNice nice-value
141            Specifies the scheduling priority ( nice(8) value) of filters that
142            are run to print a job.  The nice value ranges from 0, the highest
143            priority, to 19, the lowest priority.  The default is 0.
144
145       GSSServiceName name
146            Specifies the service name  when  using  Kerberos  authentication.
147            The default service name is "http."
148
149       HostNameLookups On
150
151       HostNameLookups Off
152
153       HostNameLookups Double
154            Specifies  whether  to  do  reverse lookups on connecting clients.
155            The "Double" setting causes cupsd(8) to verify that  the  hostname
156            resolved  from  the  address matches one of the addresses returned
157            for that hostname.   Double  lookups  also  prevent  clients  with
158            unregistered  addresses  from  connecting  to  your  server.   The
159            default is "Off" to avoid the potential server  performance  prob‐
160            lems with hostname lookups.  Only set this option to "On" or "Dou‐
161            ble" if absolutely required.
162
163       IdleExitTimeout seconds
164            Specifies the length of time to wait before shutting down  due  to
165            inactivity.   The  default is "60" seconds.  Note: Only applicable
166            when cupsd(8) is run on-demand (e.g., with -l).
167
168       JobKillDelay seconds
169            Specifies the number of seconds to wait before killing the filters
170            and  backend  associated with a canceled or held job.  The default
171            is "30".
172
173       JobRetryInterval seconds
174            Specifies the interval between retries of jobs in  seconds.   This
175            is  typically used for fax queues but can also be used with normal
176            print queues whose error policy is "retry-job" or  "retry-current-
177            job".  The default is "30".
178
179       JobRetryLimit count
180            Specifies  the  number of retries that are done for jobs.  This is
181            typically used for fax queues but can also  be  used  with  normal
182            print  queues whose error policy is "retry-job" or "retry-current-
183            job".  The default is "5".
184
185       KeepAlive Yes
186
187       KeepAlive No
188            Specifies whether to support  HTTP  keep-alive  connections.   The
189            default is "Yes".
190
191       KeepAliveTimeout seconds
192            Specifies  how  long  an idle client connection remains open.  The
193            default is "30".
194
195       <Limit operation ...> ... </Limit>
196            Specifies the IPP operations that are being limited inside a  Pol‐
197            icy  section.  IPP operation names are listed below in the section
198            "IPP OPERATION NAMES".
199
200       <Limit method ...> ... </Limit>
201
202       <LimitExcept method ...> ... </LimitExcept>
203            Specifies the HTTP methods that are being limited inside  a  Loca‐
204            tion  section.  HTTP  method names are listed below in the section
205            "HTTP METHOD NAMES".
206
207       LimitRequestBody size
208            Specifies the maximum size of print files, IPP requests, and  HTML
209            form data.  The default is "0" which disables the limit check.
210
211       Listen ipv4-address:port
212
213       Listen [ipv6-address]:port
214
215       Listen *:port
216
217       Listen /path/to/domain/socket
218            Listens  to  the  specified address and port or domain socket path
219            for connections.  Multiple Listen directives can  be  provided  to
220            listen  on multiple addresses.  The Listen directive is similar to
221            the Port directive but allows you to restrict access  to  specific
222            interfaces or networks.
223
224       ListenBackLog number
225            Specifies  the number of pending connections that will be allowed.
226            This normally only affects very busy servers that have reached the
227            MaxClients  limit,  but  can also be triggered by large numbers of
228            simultaneous connections.  When the limit is reached, the  operat‐
229            ing  system will refuse additional connections until the scheduler
230            can accept the  pending  ones.   The  default  is  the  OS-defined
231            default limit, typically either "5" for older operating systems or
232            "128" for newer operating systems.
233
234       <Location /path> ... </Location>
235            Specifies access control for the named location.  Paths are  docu‐
236            mented below in the section "LOCATION PATHS".
237
238       LogDebugHistory number
239            Specifies  the  number of debugging messages that are retained for
240            logging if an error occurs in a  print  job.  Debug  messages  are
241            logged regardless of the LogLevel setting.
242
243       LogLevel none
244
245       LogLevel emerg
246
247       LogLevel alert
248
249       LogLevel crit
250
251       LogLevel error
252
253       LogLevel warn
254
255       LogLevel notice
256
257       LogLevel info
258
259       LogLevel debug
260
261       LogLevel debug2
262            Specifies  the  level of logging for the ErrorLog file.  The value
263            "none" stops all logging  while  "debug2"  logs  everything.   The
264            default is "warn".
265
266       LogTimeFormat standard
267
268       LogTimeFormat usecs
269            Specifies  the  format of the date and time in the log files.  The
270            value "standard" is the  default  and  logs  whole  seconds  while
271            "usecs" logs microseconds.
272
273       MaxClients number
274            Specifies  the  maximum  number  of  simultaneous clients that are
275            allowed by the scheduler.  The default is "100".
276
277       MaxClientsPerHost number
278            Specifies the maximum number  of  simultaneous  clients  that  are
279            allowed  from  a  single  address.   The default is the MaxClients
280            value.
281
282       MaxCopies number
283            Specifies the maximum number of copies that a user  can  print  of
284            each job.  The default is "9999".
285
286       MaxHoldTime seconds
287            Specifies  the  maximum  time a job may remain in the "indefinite"
288            hold state before it is canceled.  The default is "0"  which  dis‐
289            ables cancellation of held jobs.
290
291       MaxJobs number
292            Specifies  the  maximum  number  of  simultaneous  jobs  that  are
293            allowed.  Set to "0" to allow an unlimited number  of  jobs.   The
294            default is "500".
295
296       MaxJobsPerPrinter number
297            Specifies the maximum number of simultaneous jobs that are allowed
298            per printer.  The default is "0" which allows up to  MaxJobs  jobs
299            per printer.
300
301       MaxJobsPerUser number
302            Specifies the maximum number of simultaneous jobs that are allowed
303            per user.  The default is "0" which allows up to MaxJobs jobs  per
304            user.
305
306       MaxJobTime seconds
307            Specifies  the  maximum  time a job may take to print before it is
308            canceled.  Set to "0" to disable  cancellation  of  "stuck"  jobs.
309            The default is "10800" (3 hours).
310
311       MaxLogSize size
312            Specifies  the  maximum  size  of  the  log  files before they are
313            rotated.  The value "0" disables log  rotation.   The  default  is
314            "1048576" (1MB).
315
316       MultipleOperationTimeout seconds
317            Specifies  the  maximum amount of time to allow between files in a
318            multiple file print job.  The default is "900" (15 minutes).
319
320       <Policy name> ... </Policy>
321            Specifies access control for the named policy.
322
323       Port number
324            Listens to the specified port number for connections.
325
326       PreserveJobFiles Yes
327
328       PreserveJobFiles No
329
330       PreserveJobFiles seconds
331            Specifies whether job files (documents) are preserved after a  job
332            is  printed.   If a numeric value is specified, job files are pre‐
333            served for the indicated number of seconds  after  printing.   The
334            default is "86400" (preserve 1 day).
335
336       PreserveJobHistory Yes
337
338       PreserveJobHistory No
339
340       PreserveJobHistory seconds
341            Specifies  whether  the  job  history  is preserved after a job is
342            printed.  If a numeric value is specified, the job history is pre‐
343            served  for  the  indicated  number of seconds after printing.  If
344            "Yes", the job history is preserved until  the  MaxJobs  limit  is
345            reached.  The default is "Yes".
346
347       ReloadTimeout seconds
348            Specifies  the  amount  of  time to wait for job completion before
349            restarting the scheduler.  The default is "30".
350
351       ServerAdmin email-address
352            Specifies the email address  of  the  server  administrator.   The
353            default value is "root@ServerName".
354
355       ServerAlias hostname [ ... hostname ]
356
357       ServerAlias *
358            The  ServerAlias directive is used for HTTP Host header validation
359            when clients connect to the scheduler  from  external  interfaces.
360            Using  the  special  name  "*"  can  expose  your  system to known
361            browser-based DNS rebinding attacks,  even  when  accessing  sites
362            through a firewall.  If the auto-discovery of alternate names does
363            not work, we recommend listing each alternate name with a  Server‐
364            Alias directive instead of using "*".
365
366       ServerName hostname
367            Specifies the fully-qualified hostname of the server.  The default
368            is the value reported by the hostname(1) command.
369
370       ServerTokens None
371
372       ServerTokens ProductOnly
373
374       ServerTokens Major
375
376       ServerTokens Minor
377
378       ServerTokens Minimal
379
380       ServerTokens OS
381
382       ServerTokens Full
383            Specifies what information is included in  the  Server  header  of
384            HTTP responses.  "None" disables the Server header.  "ProductOnly"
385            reports "CUPS".   "Major"  reports  "CUPS/major  IPP/2".   "Minor"
386            reports    "CUPS/major.minor    IPP/2.1".     "Minimal"    reports
387            "CUPS/major.minor.patch       IPP/2.1".        "OS"        reports
388            "CUPS/major.minor.path   (osname   osversion)   IPP/2.1".   "Full"
389            reports "CUPS/major.minor.path  (osname  osversion;  architecture)
390            IPP/2.1".  The default is "Minimal".
391
392       SSLListen ipv4-address:port
393
394       SSLListen [ipv6-address]:port
395
396       SSLListen *:port
397            Listens  on  the  specified address and port for encrypted connec‐
398            tions.
399
400
401       SSLOptions   [AllowDH]    [AllowRC4]    [AllowSSL3]    [DenyCBC]
402       [DenyTLS1.0]  [MaxTLS1.0]  [MaxTLS1.1]  [MaxTLS1.2]  [MaxTLS1.3]
403       [MinTLS1.0] [MinTLS1.1] [MinTLS1.2] [MinTLS1.3]
404
405       SSLOptions None
406            Sets encryption options  (only  in  /etc/cups/client.conf).
407            By default, CUPS only supports encryption using TLS v1.0 or
408            higher using  known  secure  cipher  suites.   Security  is
409            reduced  when Allow options are used.  Security is enhanced
410            when Deny options are used.   The  AllowDH  option  enables
411            cipher  suites  using  plain Diffie-Hellman key negotiation
412            (not supported on systems using  GNU  TLS).   The  AllowRC4
413            option  enables  the  128-bit  RC4 cipher suites, which are
414            required for some  older  clients.   The  AllowSSL3  option
415            enables  SSL v3.0, which is required for some older clients
416            that do not support TLS v1.0.  The DenyCBC option  disables
417            all  CBC cipher suites.  The DenyTLS1.0 option disables TLS
418            v1.0 support - this sets the minimum  protocol  version  to
419            TLS  v1.1.   The MinTLS options set the minimum TLS version
420            to support.  The MaxTLS options set the maximum TLS version
421            to  support.   Not all operating systems support TLS 1.3 at
422            this time.
423
424       SSLPort port
425            Listens on the specified port for encrypted connections.
426
427       StrictConformance Yes
428
429       StrictConformance No
430            Specifies  whether  the  scheduler  requires   clients   to
431            strictly  adhere to the IPP specifications.  The default is
432            "No".
433
434       Timeout seconds
435            Specifies the HTTP request timeout.  The default  is  "900"
436            (15 minutes).
437
438       WebInterface yes
439
440       WebInterface no
441            Specifies  whether  the  web  interface  is  enabled.   The
442            default is "No".
443
444   HTTP METHOD NAMES
445       The following HTTP methods are supported by cupsd(8):
446
447       GET  Used by a  client  to  download  icons  and  other  printer
448            resources and to access the CUPS web interface.
449
450       HEAD Used  by  a  client to get the type, size, and modification
451            date of resources.
452
453       OPTIONS
454            Used by a client to establish a  secure  (SSL/TLS)  connec‐
455            tion.
456
457       POST Used by a client to submit IPP requests and HTML forms from
458            the CUPS web interface.
459
460       PUT  Used by a client to upload configuration files.
461
462   IPP OPERATION NAMES
463       The following IPP operations are supported by cupsd(8):
464
465       CUPS-Accept-Jobs
466            Allows a printer to accept new jobs.
467
468       CUPS-Add-Modify-Class
469            Adds or modifies a printer class.
470
471       CUPS-Add-Modify-Printer
472            Adds or modifies a printer.
473
474       CUPS-Authenticate-Job
475            Releases a job that is held for authentication.
476
477       CUPS-Delete-Class
478            Deletes a printer class.
479
480       CUPS-Delete-Printer
481            Deletes a printer.
482
483       CUPS-Get-Classes
484            Gets a list of printer classes.
485
486       CUPS-Get-Default
487            Gets the server default printer or printer class.
488
489       CUPS-Get-Devices
490            Gets a list of devices that are currently available.
491
492       CUPS-Get-Document
493            Gets a document file for a job.
494
495       CUPS-Get-PPD
496            Gets a PPD file.
497
498       CUPS-Get-PPDs
499            Gets a list of installed PPD files.
500
501       CUPS-Get-Printers
502            Gets a list of printers.
503
504       CUPS-Move-Job
505            Moves a job.
506
507       CUPS-Reject-Jobs
508            Prevents a printer from accepting new jobs.
509
510       CUPS-Set-Default
511            Sets the server default printer or printer class.
512
513       Cancel-Job
514            Cancels a job.
515
516       Cancel-Jobs
517            Cancels one or more jobs.
518
519       Cancel-My-Jobs
520            Cancels one or more jobs creates by a user.
521
522       Cancel-Subscription
523            Cancels a subscription.
524
525       Close-Job
526            Closes a job that is waiting for more documents.
527
528       Create-Job
529            Creates a new job with no documents.
530
531       Create-Job-Subscriptions
532            Creates a subscription for job events.
533
534       Create-Printer-Subscriptions
535            Creates a subscription for printer events.
536
537       Get-Job-Attributes
538            Gets information about a job.
539
540       Get-Jobs
541            Gets a list of jobs.
542
543       Get-Notifications
544            Gets a list of event notifications for a subscription.
545
546       Get-Printer-Attributes
547            Gets information about a printer or printer class.
548
549       Get-Subscription-Attributes
550            Gets information about a subscription.
551
552       Get-Subscriptions
553            Gets a list of subscriptions.
554
555       Hold-Job
556            Holds a job from printing.
557
558       Hold-New-Jobs
559            Holds all new jobs from printing.
560
561       Pause-Printer
562            Stops processing of jobs by a printer or printer class.
563
564       Pause-Printer-After-Current-Job
565            Stops processing of jobs by  a  printer  or  printer  class
566            after the current job is finished.
567
568       Print-Job
569            Creates a new job with a single document.
570
571       Purge-Jobs
572            Cancels one or more jobs and deletes the job history.
573
574       Release-Held-New-Jobs
575            Allows previously held jobs to print.
576
577       Release-Job
578            Allows a job to print.
579
580       Renew-Subscription
581            Renews a subscription.
582
583       Restart-Job
584            Reprints a job, if possible.
585
586       Send-Document
587            Adds a document to a job.
588
589       Set-Job-Attributes
590            Changes job information.
591
592       Set-Printer-Attributes
593            Changes printer or printer class information.
594
595       Validate-Job
596            Validates options for a new job.
597
598   LOCATION PATHS
599       The following paths are commonly used when configuring cupsd(8):
600
601       /    The  path  for  all get operations (get-printers, get-jobs,
602            etc.)
603
604       /admin
605            The path for all  administration  operations  (add-printer,
606            delete-printer, start-printer, etc.)
607
608       /admin/conf
609            The  path  for  access  to  the  CUPS  configuration  files
610            (cupsd.conf, client.conf, etc.)
611
612       /admin/log
613            The path for access to  the  CUPS  log  files  (access_log,
614            error_log, page_log)
615
616       /classes
617            The path for all printer classes
618
619       /classes/name
620            The resource for the named printer class
621
622       /jobs
623            The path for all jobs (hold-job, release-job, etc.)
624
625       /jobs/id
626            The path for the specified job
627
628       /printers
629            The path for all printers
630
631       /printers/name
632            The path for the named printer
633
634       /printers/name.png
635            The icon file path for the named printer
636
637       /printers/name.ppd
638            The PPD file path for the named printer
639
640   DIRECTIVES VALID WITHIN LOCATION AND LIMIT SECTIONS
641       The following directives may be placed inside Location and Limit
642       sections in the cupsd.conf file:
643
644       Allow all
645
646       Allow none
647
648       Allow host.domain.com
649
650       Allow *.domain.com
651
652       Allow ipv4-address
653
654       Allow ipv4-address/netmask
655
656       Allow ipv4-address/mm
657
658       Allow [ipv6-address]
659
660       Allow [ipv6-address]/mm
661
662       Allow @IF(name)
663
664       Allow @LOCAL
665            Allows access from the named hosts, domains, addresses,  or
666            interfaces.   The  @IF(name)  form uses the current subnets
667            configured for the named interface.  The @LOCAL  form  uses
668            the  current subnets configured for all interfaces that are
669            not point-to-point, for example Ethernet and  Wi-Fi  inter‐
670            faces  are  used  but  DSL and VPN interfaces are not.  The
671            Order directive controls whether Allow lines are  evaluated
672            before or after Deny lines.
673
674       AuthType None
675
676       AuthType Basic
677
678       AuthType Default
679
680       AuthType Negotiate
681            Specifies  the  type of authentication required.  The value
682            "Default" corresponds to the DefaultAuthType value.
683
684       Deny all
685
686       Deny none
687
688       Deny host.domain.com
689
690       Deny *.domain.com
691
692       Deny ipv4-address
693
694       Deny ipv4-address/netmask
695
696       Deny ipv4-address/mm
697
698       Deny [ipv6-address]
699
700       Deny [ipv6-address]/mm
701
702       Deny @IF(name)
703
704       Deny @LOCAL
705            Denies access from the named hosts, domains, addresses,  or
706            interfaces.   The  @IF(name)  form uses the current subnets
707            configured for the named interface.  The @LOCAL  form  uses
708            the  current subnets configured for all interfaces that are
709            not point-to-point, for example Ethernet and  Wi-Fi  inter‐
710            faces  are  used  but  DSL and VPN interfaces are not.  The
711            Order directive controls whether Deny lines  are  evaluated
712            before or after Allow lines.
713
714       Encryption IfRequested
715
716       Encryption Never
717
718       Encryption Required
719            Specifies  the  level  of encryption that is required for a
720            particular location.  The default value is "IfRequested".
721
722       Order allow,deny
723            Specifies that access is denied by default. Allow lines are
724            then  processed followed by Deny lines to determine whether
725            a client may access a particular resource.
726
727       Order deny,allow
728            Specifies that access is allowed by default. Deny lines are
729            then processed followed by Allow lines to determine whether
730            a client may access a particular resource.
731
732       Require group group-name [ group-name ... ]
733            Specifies that an authenticated user must be  a  member  of
734            one of the named groups.
735
736       Require user {user-name|@group-name} ...
737            Specifies  that an authenticated user must match one of the
738            named users or be a member of one of the named groups.  The
739            group  name  "@SYSTEM"  corresponds  to  the list of groups
740            defined  by  the  SystemGroup  directive   in   the   cups-
741            files.conf(5) file.  The group name "@OWNER" corresponds to
742            the owner of the resource, for example the person that sub‐
743            mitted  a  print job.  Note: The 'root' user is not special
744            and must be granted privileges like any other user account.
745
746       Require valid-user
747            Specifies that any authenticated user is acceptable.
748
749       Satisfy all
750            Specifies  that  all  Allow,  AuthType,  Deny,  Order,  and
751            Require conditions must be satisfied to allow access.
752
753       Satisfy any
754            Specifies that any a client may access a resource if either
755            the   authentication    (AuthType/Require)    or    address
756            (Allow/Deny/Order)  conditions are satisfied.  For example,
757            this can be used to require authentication only for  remote
758            accesses.
759
760   DIRECTIVES VALID WITHIN POLICY SECTIONS
761       The following directives may be placed inside Policy sections in
762       the cupsd.conf file:
763
764       JobPrivateAccess all
765
766       JobPrivateAccess default
767
768       JobPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM} ...
769            Specifies an access list for a job's private  values.   The
770            "default"  access list is "@OWNER @SYSTEM".  "@ACL" maps to
771            the printer's requesting-user-name-allowed  or  requesting-
772            user-name-denied values.  "@OWNER" maps to the job's owner.
773            "@SYSTEM" maps to the groups  listed  for  the  SystemGroup
774            directive in the cups-files.conf(5) file.
775
776       JobPrivateValues all
777
778       JobPrivateValues default
779
780       JobPrivateValues none
781
782       JobPrivateValues attribute-name [ ... attribute-name ]
783            Specifies  the  list  of  job  values to make private.  The
784            "default"  values  are  "job-name",  "job-originating-host-
785            name", "job-originating-user-name", and "phone".
786
787       SubscriptionPrivateAccess all
788
789       SubscriptionPrivateAccess default
790
791       SubscriptionPrivateAccess {user|@group|@ACL|@OWNER|@SYSTEM} ...
792            Specifies  an access list for a subscription's private val‐
793            ues.   The  "default"  access  list  is  "@OWNER  @SYSTEM".
794            "@ACL"  maps  to the printer's requesting-user-name-allowed
795            or requesting-user-name-denied values.   "@OWNER"  maps  to
796            the  job's  owner.  "@SYSTEM" maps to the groups listed for
797            the SystemGroup directive in the cups-files.conf(5) file.
798
799       SubscriptionPrivateValues all
800
801       SubscriptionPrivateValues default
802
803       SubscriptionPrivateValues none
804
805       SubscriptionPrivateValues attribute-name [ ... attribute-name ]
806            Specifies the list of subscription values to make  private.
807            The  "default"  values  are  "notify-events", "notify-pull-
808            method",  "notify-recipient-uri",  "notify-subscriber-user-
809            name", and "notify-user-data".
810
811   DEPRECATED DIRECTIVES
812       The following directives are deprecated and will be removed in a
813       future release of CUPS:
814
815       Classification banner
816            Specifies the security classification of the  server.   Any
817            valid  banner  name  can  be  used, including "classified",
818            "confidential", "secret", "topsecret", and  "unclassified",
819            or  the  banner  can  be omitted to disable secure printing
820            functions.  The default is no classification banner.
821
822       ClassifyOverride Yes
823
824       ClassifyOverride No
825            Specifies whether users  may  override  the  classification
826            (cover  page)  of  individual  print  jobs  using the "job-
827            sheets" option.  The default is "No".
828
829       PageLogFormat format-string
830            Specifies the format of PageLog lines.  Sequences beginning
831            with  percent  (%)  characters are replaced with the corre‐
832            sponding information, while all other characters are copied
833            literally.  The following percent sequences are recognized:
834
835                "%%" inserts a single percent character.
836                "%{name}" inserts the value of the specified IPP attribute.
837                "%C" inserts the number of copies for the current page.
838                "%P" inserts the current page number.
839                "%T" inserts the current date and time in common log format.
840                "%j" inserts the job ID.
841                "%p" inserts the printer name.
842                "%u" inserts the username.
843
844            The  default  is the empty string, which disables page log‐
845            ging.  The string "%p %u %j %T %P %C %{job-billing}  %{job-
846            originating-host-name}  %{job-name} %{media} %{sides}" cre‐
847            ates a page log  with  the  standard  items.   Use  "%{job-
848            impressions-completed}"  to  insert  the  number  of  pages
849            (sides)  that  were  printed,  or  "%{job-media-sheets-com‐
850            pleted}" to insert the number of sheets that were printed.
851
852       RIPCache size
853            Specifies the maximum amount of memory to use when convert‐
854            ing documents into bitmaps for a printer.  The  default  is
855            "128m".
856

NOTES

858       File,  directory, and user configuration directives that used to
859       be allowed in the cupsd.conf file are now stored  in  the  cups-
860       files.conf(5)  file instead in order to prevent certain types of
861       privilege escalation attacks.
862
863       The scheduler MUST be restarted manually after making changes to
864       the  cupsd.conf file.  On Linux this is typically done using the
865       systemctl(8) command, while on macOS the launchctl(8) command is
866       used instead.
867
868       The  @LOCAL macro name can be confusing since the system running
869       cupsd often belongs to a  different  set  of  subnets  from  its
870       clients.
871

CONFORMING TO

873       The  cupsd.conf  file  format is based on the Apache HTTP Server
874       configuration file format.
875

EXAMPLES

877       Log everything with a maximum log file size of 32 megabytes:
878
879           AccessLogLevel all
880           LogLevel debug2
881           MaxLogSize 32m
882
883       Require authentication for accesses from outside  the  10.  net‐
884       work:
885
886           <Location />
887           Order allow,deny
888           Allow from 10./8
889           AuthType Basic
890           Require valid-user
891           Satisfy any
892           </Location>
893

SEE ALSO

895       classes.conf(5),  cups-files.conf(5),  cupsd(8),  mime.convs(5),
896       mime.types(5),  printers.conf(5),  subscriptions.conf(5),   CUPS
897       Online Help (http://localhost:631/help)
898
900       Copyright © 2007-2019 by Apple Inc.
901
902
903
90416 July 2019                         CUPS                        cupsd.conf(5)
Impressum