root / pykota / trunk / conf / pykota.conf.sample @ 3241

Revision 3241, 52.7 kB (checked in by jerome, 17 years ago)

Improved the documentation of the 'policy' directive.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
Line 
1# PyKota sample configuration file
2#
3#
4# File format :
5#
6#   - A mandatory [global] section :
7#
8#     Contains configuration directives which apply for all printers.
9#     Some directives MUST be set in the [global] section, e.g.
10#     database related directives.
11#
12#   - Any number of optional [PrintQueueName] sections :
13#
14#     Contain directives which apply for a particular print queue only.
15#
16#     Override the values of the same directives present in [global].
17#
18#
19# Directives format :
20#
21#   - Directive's name, followed by ':' followed by the directive's value.
22#
23#   - No leading whitespace : leading whitespace tell the parser that the
24#     current directive is the continuation of the previous one. Use with
25#     care and only when you need it.
26#
27#
28# PyKota - Print Quotas for CUPS and LPRng
29#
30# (c) 2003, 2004, 2005, 2006, 2007 Jerome Alet <alet@librelogiciel.com>
31# This program is free software; you can redistribute it and/or modify
32# it under the terms of the GNU General Public License as published by
33# the Free Software Foundation; either version 2 of the License, or
34# (at your option) any later version.
35#
36# This program is distributed in the hope that it will be useful,
37# but WITHOUT ANY WARRANTY; without even the implied warranty of
38# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
39# GNU General Public License for more details.
40#
41# You should have received a copy of the GNU General Public License
42# along with this program; if not, write to the Free Software
43# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
44#
45# $Id$
46#
47
48
49#
50# All directives must be placed below the following line
51[global]
52
53
54
55####################################################################
56# SQLite3 : comment this section out if you use another backend    #
57####################################################################
58
59#storagebackend : sqlitestorage
60#storagename: /etc/pykota/pykota.db
61
62####################################################################
63
64
65
66############################################################################
67# PostgreSQL or MySQL: comment this section out if you use another backend #
68############################################################################
69storagebackend: pgstorage
70# storagebackend: mysqlstorage
71
72# Quota Storage Server hostname (and optional port)
73# e.g. db.example.com:5432 (for PostgreSQL) or db.example.com:3306 (for MySQL)
74# NB : leave the directive empty to use unix sockets (same host only)
75storageserver: localhost
76
77#
78# name of the Quota Storage Database
79storagename: pykota
80
81#
82# Quota Storage normal user's name and password
83# These two fields contain a username and optional password
84# which may give readonly access to your print quota database.
85#
86# PLEASE ENSURE THAT THIS USER CAN'T WRITE TO YOUR PRINT QUOTA
87# DATABASE, OTHERWISE ANY USER WHO COULD READ THIS CONFIGURATION
88# FILE COULD CHANGE HIS PRINT QUOTA.
89#
90storageuser : pykotauser
91# In the line below change the password's value if needed.
92storageuserpw : readonlypw
93
94############################################################################
95
96
97
98####################################################################
99# LDAP : comment this section out if you use another backend       #
100####################################################################
101# LDAP example, uncomment and adapt it to your own configuration :
102#
103#storagebackend: ldapstorage
104#storageserver: ldap://ldap.example.com:389
105#storagename: dc=example,dc=com
106#
107# NB : the user and password below are the ones contained in
108# the sample LDIF file pykota/initscripts/ldap/pykota-sample.ldif
109# Please adapt these lines to your own needs.
110#
111#storageuser: cn=pykotauser,dc=example,dc=com
112#storageuserpw: ls88DT5j
113
114
115
116# TLS support for LDAP
117#
118# ldaptls can be set to either Yes or No
119# the default value when not set is No, meaning that TLS won't be used.
120#
121#ldaptls: No
122#
123# cacert points to the CA Certificate file to use for TLS.
124# Ensure that every user who can launch PyKota commands can read this file.
125# There's NO default value for this directive.
126#
127#cacert: /etc/pykota/mycertfile
128
129
130
131# Here we define some helpers to know where
132# to plug into an existing LDAP directory
133# NB : THE DIRECTIVES BELOW MUST BE PRESENT WITH AN LDAP BACKEND
134# BUT YOU ARE FREE TO CHANGE THE VALUES.
135#
136#userbase: ou=People,dc=example,dc=com
137#userrdn: uid
138#balancebase: ou=People,dc=example,dc=com
139#balancerdn: uid
140#groupbase: ou=Groups,dc=example,dc=com
141#grouprdn: cn
142#printerbase: ou=Printers,ou=PyKota,dc=example,dc=com
143#printerrdn: cn
144#jobbase: ou=Jobs,ou=PyKota,dc=example,dc=com
145#lastjobbase: ou=LastJobs,ou=PyKota,dc=example,dc=com
146#billingcodebase: ou=BillingCodes,ou=PyKota,dc=example,dc=com
147
148# These two fields are special, they either accept a branch
149# dn, like an ou for example, or the special keywords 'user'
150# and 'group'. If 'user' or 'group' is used, the print quota
151# entries will be created below the user or group entry itself,
152# which will then be used like a branch (you can mix and match
153# different values depending on what you want to do).
154#
155# NB : YOU MUST CHOOSE A VALUE FOR USERQUOTABASE AND A VALUE
156# FOR GROUPQUOTABASE, BUT ONLY ONE LINE OF EACH MUST BE PRESENT.
157#userquotabase: user
158#userquotabase: ou=UQuotas,ou=PyKota,dc=example,dc=com
159#groupquotabase: group
160#groupquotabase: ou=GQuotas,ou=PyKota,dc=example,dc=com
161
162
163
164# How to create new accounts and groups
165# authorized values are "below" and "attach(objectclass name [, fail|warn])"
166#
167# "below" creates the new accounts/groups as standalone entries
168# below the above defined 'userbase' ou
169#
170# attach(objectclass name [, action]) tries to find some existing user/group
171# using the above defined 'userrdn' or 'grouprdn' and 'userbase'
172# 'groupbase', and attach the PyKota specific entries to it.
173# if action is "warn" and no entry exists to attach to, a new
174# entry is created, and a message is logged.
175# if action is "fail" and no entry exists to attach to, program
176# logs an error message and aborts.
177# if action is not set, the default value is "fail".
178#
179# a possible value:  newuser: attach(posixAccount, warn)
180#
181#newuser : below
182#newgroup : below
183
184
185
186# LDAP attribute which stores the user's email address
187#
188#usermail : mail
189
190
191
192# Choose what attribute contains the list of group members
193# common values are : memberUid, uniqueMember, member
194#
195#groupmembers: memberUid
196
197
198
199# Activate low-level LDAP cache yes/no
200# Nothing to do with "storagecaching" which is higher level
201# and database independant.
202# This saves some search queries and may help with heavily
203# loaded LDAP servers.
204# This is EXPERIMENTAL.
205#
206# BEWARE : SETTING THIS TO 'YES' CAUSES PROBLEMS FOR NOW
207# BETTER TO LET IT SET TO 'NO'
208#
209# ldapcache: no
210
211####################################################################
212
213#############################################################
214# END of database specific directives                       #
215#############################################################
216
217
218
219# Should the database caching mechanism be enabled or not ?
220# If unset, caching is disabled. Possible values Y/N/YES/NO
221# caching mechanism works with both relationnal and OpenLDAP backends
222# but may be really interesting only with OpenLDAP.
223#
224# ACTIVATING CACHE MAY CAUSE PRECISION PROBLEMS IN PRINT ACCOUNTING
225# IF AN USER PRINTS ON SEVERAL PRINTERS AT THE SAME TIME.
226# YOU MAY FIND IT INTERESTING ANYWAY, ESPECIALLY FOR LDAP.
227#
228# THERE'S NO GUARANTEE THAT THIS CACHING MECHANISM WILL IMPROVE
229# PERFORMANCE WITH RELATIONNAL BACKENDS. IT MIGHT EVEN MAKE
230# PERFORMANCE DECREASE. AS ALWAYS : YMMV.
231#
232# FYI, I ALWAYS SET IT TO YES !
233#
234storagecaching: No
235
236
237
238# Should full job history be disabled ?
239# If unset or set to No, full job history is kept in the database.
240# Disabling the job history can be useful with heavily loaded
241# LDAP servers, to not make the LDAP tree grow out of control.
242# Disabling the job history with a relationnal backend works too
243# but it's probably less useful than with LDAP.
244#
245disablehistory: No
246
247
248
249# Where to log ?
250# supported values : stderr, system (system means syslog, but don't use
251# 'syslog' here). if the value is not set then the default SYSTEM applies.
252#
253logger: system
254
255
256
257# Enable debugging ? Put YES or NO there.
258# debug is set to YES in this sample configuration file, so debugging
259# is activated when configuring PyKota, which helps a lot. After all
260# works, just put NO instead to save some disk space in your logs.
261# NB : When set to YES, there is a very significant impact on performance
262# when managing many users, printers or billing codes at once, because
263# hundreds of thousands of log lines can be generated.
264# When printing a job, typically around 250-300 log lines are generated,
265# so the impact per job is really minimal. Note however that this will
266# add up over a large number of jobs.
267#
268debug : Yes
269
270
271
272# The URL to PyKota's logo when used from the CGI scripts.
273# You can use your own logo by modifying the URL below.
274# If not defined, the default URL is the same as the
275# one defined below :
276#
277logourl : http://www.pykota.com/pykota.png
278
279
280
281# The destination to which the web browser will be redirected
282# when you click on the logo defined above.
283# If not defined, the default URL is the same as the
284# one defined below :
285#
286logolink : http://www.pykota.com/
287
288
289
290# Mail server to use to warn users
291# If the value is not set then localhost is used.
292#
293smtpserver: localhost
294
295
296
297# Crash messages' recipient : in addition to the log files
298# each software crash can be sent to the author of PyKota
299# or any other person of your choice. By default this
300# is disabled for privacy concerns (see below). The address
301# pykotacrashed@librelogiciel.com reaches PyKota's author.
302# The 'adminmail' (defined a bit below) is CCed.
303#
304# Privacy concerns : what is sent is only :
305#
306#        - a copy of the software's traceback
307#        - a copy of the software's command line arguments
308#        - a copy of the software's environment variables
309#
310# suggested value :
311#
312# crashrecipient: pykotacrashed@librelogiciel.com
313
314
315
316# Email domain
317# If the value is not set, and the mail attribute for the user
318# is not set in the PyKota storage, be it LDAP (see usermail directive
319# above) or a relationnal one, then email messages are sent to
320# username@smtpserver
321#
322# If the value is set, then email messages are sent to
323# username@maildomain using the SMTP server defined above
324#
325# Set the appropriate value below, example.com set as per RFC2606.
326#
327maildomain: example.com
328
329
330
331# Should we modify usernames when printing ?
332# Default is native, meaning usernames won't be modified.
333# This is a [global] option only.
334# Some people reported that WinXP sends mixed case usernames,
335# setting usernamecase to 'upper' or 'lower' solves the problem.
336# Of course you have to use uppercase or lowercase only when managing
337# users with pkusers, because ALL database accesses are
338# still case sensitive.
339#
340# If usernamecase is 'upper' or 'lower', the usernames received
341# from the printing system are converted to uppercase or lowercase,
342# respectively, at the start of printing, BUT ONLY when printing.
343#
344# If usernamecase is 'native', which is the default, strict case checking
345# is done, this means that users 'Jerome' and 'jerome' are
346# different. Printer and groups names are ALWAYS case sensitive.
347#
348# usernamecase : upper
349# usernamecase : lower
350usernamecase: native
351
352
353
354# Should we split usernames on a specific separator when printing ?
355# Default is No, i.e. if the value is unset.
356# This is a [global] option only.
357# This option adds support for Samba's Winbind utility, which
358# prefixes usernames with domain name and separator character.
359# Of course if you set this then you have to use NO separator when
360# adding users with edpykota.
361#
362# If winbind_separator is set, the usernames received from the printing
363# system are split on the separator's value, and only the last part
364# (real username) is used.
365#
366# If winbind_separator is not set, which is the default, strict
367# username equality checking will be done (modulo the setting
368# of the 'utolower' directive), this means that users 'DOMAIN1/jerome',
369# 'Domain2/jerome' and 'jerome' are different.
370#
371# winbind_separator: /
372
373
374
375# When creating users or groups accounts, should we reject users
376# or groups which are unknown from the system ?
377# The default if unset is NO. This means that by default, you
378# can create users or groups for which `getent passwd username`
379# or `getent group groupname` returns nothing.
380#
381# Allowed values : Yes | No
382# Default value : No
383#
384# reject_unknown: No
385
386
387
388# Do we want to hide jobs' title, filename and options for privacy
389# reasons ?
390# This may be required in some countries (Italy comes to mind).
391# Allowed values are YES and NO.
392# If unset, the default value is NO, meaning that jobs' title, filename
393# and options will be saved into the history.
394# This option can't be set on a per printer basis, only into the
395# [global] section.
396#
397privacy : no
398
399
400
401# When the real CUPS backend fail, should we modify the
402# user's page counters and account balance or not ?
403# Also should we retry and if yes then how often and how many times ?
404# If you trust your users, set it to "nocharge".
405# If you think they found some mean to kill the real CUPS backend,
406# then set it to "charge".
407# If your print queues get regularly disabled by CUPS when the printers
408# are switched off, you might want to set it to "retry:N:S" where
409# N is the number of times the operation should be retried, and S is
410# the delay in seconds during which PyKota will sleep before trying again.
411# This 'retry' feature works in a way similar to Till Kamppeter's beh
412# backend wrapper which offers this functionnality but is actually not
413# compatible with PyKota (because of my own inability to master regular
414# expressions).
415# If N is 0, PyKota will retry indefinitely each S seconds until the
416# backend succeeds, so you should use this with caution. If N is 0,
417# of course neither "charge" nor "nocharge" will be honored.
418# You can combine "charge" or "nocharge" with "retry:N:S" if you want,
419# by separating the values with a comma as shown in the examples below.
420# If unset, the default value is "nocharge", meaning that users won't be
421# charged whenever a CUPS backend fails. This is the OPPOSITE
422# behavior compared to PyKota versions prior to 1.24alpha2.
423# This value can be set either globally or on a per printer basis
424# If both are defined, the printer option has priority.
425#
426# onbackenderror : charge,retry:5:60
427# onbackenderror : retry:0:300
428# onbackenderror : retry:3:300,nocharge
429# onbackenderror : charge
430onbackenderror : nocharge
431
432
433
434# Should we strip off some characters from the beginning of
435# print jobs' titles ? This can be used to remove smbprn.??????
436# which sometimes appear when printing in raw mode from Windows
437# through Samba.
438# This setting only applies at printing time.
439# When not set, titles are used as received from the printing system.
440# The default is to not strip any character off of jobs' titles.
441# This value can be set either globally or on a per printer basis
442# If both are defined, the printer option has priority.
443#
444# striptitle : smbprn.??????
445
446
447
448# Should we launch a command to overwrite the job's ticket ?
449# This allows a command to overwrite the username and/or the
450# billing code used, or to deny or cancel the job.
451# If unset no command is launched and the job's username and
452# billing code are used as they are received.
453# To overwrite the job's ticket, the command has to print
454# on its standard output one or more of the following lines,
455# without any prefix or space character :
456#
457#    USERNAME=the_username_we_want_to_overwrite_with
458#    BILLINGCODE=the_billingcode_we_want_to_overwrite_with
459#    REASON=reason_we_chose_deny_or_cancel
460#    AUTH=NO (equivalent to DENY below)
461#    DENY
462#    CANCEL
463#
464# NB : the output of your command is entirely read, and the latest
465# value seen is used, so you command can output several usernames
466# or billing codes and only the latest ones will be used.
467# If only USERNAME= lines are printed, the billing code,
468# if any, is used unchanged.
469# If only BILLINGCODE= lines are printed, the username is
470# used unchanged.
471# If DENY or CANCEL is output, neither the username nor the
472# billing code can be overwritten.
473# If REASON is output, that will be used in the notification in the case of
474# DENY or CANCEL. Otherwise, the built-in reasons will be used.
475#
476# This value can be set either globally or on a per printer basis
477# If both are defined, the printer option has priority.
478#
479#�IMPORTANT :
480#
481#       If you use this directive to interact with the end user in
482#       some way, for example through pknotify+pykoticon or similar
483#       tools, you have to keep in mind that this directive, as all
484#       the directives in pykota*.conf, is processed at the time
485#       the print job reaches the top of the print queue, and not
486#       at the time it enters the print queue. For heavily loaded
487#       systems where several jobs are in the print queue at a given
488#       time, there may be a significant delay between the moment the
489#       user submits the print job, and the moment this directive is
490#       processed.
491#
492# examples :
493#
494# overwrite_jobticket : /usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 180 --denyafter 3 --checkauth --ask "Username:username:$PYKOTAUSERNAME" "Password:password:" "Billing code:billingcode:$PYKOTAJOBBILLING"
495# overwrite_jobticket : /path/to/some/script/or/command
496
497
498
499# Should we ask the end user for a confirmation about their print job ?
500#
501# Any script can be launched here. If your script prints CANCEL on
502# its standard output, the job is cancelled, else processing of the
503# job continues to next step.
504#
505# NB : the output of your command is read until CANCEL is found
506# or all lines have been read.
507#
508# This value can be set either globally or on a per printer basis
509# If both are defined, the printer option has priority.
510#
511# examples :
512#
513# askconfirmation : /usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 120 --confirm "Hello $PYKOTAUSERNAME.\nPrint job $PYKOTAJOBID send to printer $PYKOTAPRINTERNAME is $PYKOTAPRECOMPUTEDJOBSIZE pages long\nand will cost you $PYKOTAPRECOMPUTEDJOBPRICE credits.\n\nYou currently have $PYKOTABALANCE credits.\n\nDo you really want to print ?"
514
515
516
517# What should we do when we print and the billing code used is
518# not present in the database ?
519# The default value is 'create' which adds the billing code to the
520# database.
521# Other values can be :
522#       deny
523#     which silently rejects the job.
524# or :
525#       deny(your script here)
526#     if you put the path to a script or command here, it is executed, for
527#     example you can open a popup window explaining why the job was
528#     rejected.
529#
530# This value can be set either globally or on a per printer basis
531# If both are defined, the printer option has priority.
532#
533# unknown_billingcode : deny
534# unknown_billingcode : deny(/usr/bin/pknotify --destination $PYKOTAJOBORIGINATINGHOSTNAME:7654 --timeout 60 --notify "The billing code specified is not allowed")
535# unknown_billingcode : deny(/path/to/some/script)
536# unknown_billingcode : create
537
538
539
540# Where should we store our (temporary) files when printing ?
541# if unset, defaults to a system directory dedicated to temporary
542# files and evaluated at runtime (see Python's documentation
543# for the tempfile.gettempdir() function).
544# This value can be set either globally or on a per printer basis
545# If both are defined, the printer option has priority.
546# On my system, when not set, the /var/spool/cups/tmp directory is used.
547# directory : /tmp
548# directory : /var/spool/cups
549
550
551
552# Should we keep our work files on disk after printing ?
553# If unset, temporary files are deleted once the work is finished.
554# If set to yes, files are kept on disk in the 'directory'
555# named with the previous directive.
556# This value can be set either globally or on a per printer basis
557# If both are defined, the printer option has priority.
558# Default value is No, meaning temporary files are deleted
559# You should set it to yes only during installation to not
560# waste disk space during normal use.
561#
562# keepfiles : yes
563keepfiles : no
564
565
566
567# What is the accounting backend to use : this defines the way PyKota
568# will compute the number of pages printed. This directive is the most
569# important one in PyKota's configuration.
570#
571# NB : This directive is MANDATORY, there's no default value when not set.
572#
573# Supported values :
574#
575# - software([/path/to/some/script[ --with-args]])
576# - hardware(snmp[:community]|pjl[:port]|/path/to/some/script[ --with-args])
577#
578# Hardware asks the printer for its lifetime page counter through either
579# SNMP, PJL-over-TCP, or through any command of your choice. This is
580# the recommended way to use PyKota, although it might not work with some
581# printers. The page counter is asked twice per job : before the job
582# is sent to the printer, and after it has been entirely sent.
583# The big advantages of hardware accounting are lighter CPU usage compared
584# to software accounting described below, although it can take more time
585# because of necessary internal counter stabilization delays, and the fact
586# that paper jams don't cause users to be charged for pages they couldn't
587# print.
588# For hardware accounting, two special values are accepted in addition
589# to a script name : snmp and pjl. 'snmp' asks PyKota to use its internal
590# SNMP code, 'pjl' asks PyKota to internally send a specially crafter PJL
591# job to the printer's TCP port 9100 (by default).
592#
593# Software counts pages by parsing the print job's datas, either internally
594# when no script is specified, or through any script of your choice.
595# This works with ALL printers, provided you've got a script to parse
596# datas produced by your printer driver. PyKota's internal parser, also
597# available under the name 'pkpgcounter', recognizes several page description
598# languages, but may occasionally fail for some printer drivers.
599# You can however use any other command, provided it can read the datas to
600# parse from its standard input, and prints a single integer on its standard
601# output, representing the number of pages in the print job.
602# Software accounting unfortunately may overcharge users in case of paper
603# jams.
604#
605# Ink computes the price of a print job by parsing the job's datas
606# through pkpgcounter, and using the percents of ink coverage returned
607# for each color in the specified colorspace.
608
609# Supported colorspaces for ink accounting currently are :
610#
611#       bw      ===> Black & White
612#       cmyk    ===> Cyan, Magenta, Yellow, Black
613#       cmy     ===> Cyan, Magenta, Yellow
614#       rgb     ===> Red, Green, Blue
615#       gc      ===> Grayscale, Colored : this is a pseudo colorspace useful
616#                    if all you need is differentiating grayscale from
617#                    colored pages.
618#
619# Supported resolutions for ink accounting are any number of dots
620# per inch comprised between 72 and 1200.
621# IMPORTANT : increasing the resolution increases precision, but
622# increase CPU load a lot at the same time. The default resolution
623# if unset is 72, for 72 dpi.
624# If you want to use ink accounting, you have to define a set of
625# coefficients for each color in the colorspace, as explained
626# further below in this file.
627#
628# You can get hints on which configuration is best for your printers by
629# typing : pkturnkey --doconf
630#
631# In the lines below "%(printer)s" is automatically replaced at run time
632# with your printer's Fully Qualified Domain Name for network printers,
633# if PyKota can extract it from its environment.
634#
635# Examples :
636#
637# accounter : hardware(snmp)
638# accounter : hardware(snmp:private)
639# accounter : hardware(pjl)
640# accounter : hardware(pjl:9101)
641# accounter : hardware(/usr/share/pykota/waitprinter.sh %(printer)s && /usr/bin/snmpget -v1 -c public -Ov %(printer)s mib-2.43.10.2.1.4.1.1 | cut -f 2,2 -d " ")
642# accounter : hardware(/usr/bin/npadmin --pagecount %(printer)s)
643# accounter : hardware(/usr/share/pykota/papwaitprinter.sh "MyPrinter:LaserWriter@*" && /usr/bin/pap -p "MyPrinter:LaserWriter@*" /usr/share/pykota/pagecount.ps  2>/dev/null | /bin/grep -v status | /bin/grep -v Connect | /usr/bin/tail -1)
644# accounter : hardware(/bin/cat /usr/share/pykota/pagecount.pjl >/dev/lp0 && /usr/bin/head -2 </dev/lp0 | /usr/bin/tail -1)
645# accounter : hardware(/opt/local/net-snmp/bin/snmpwalk -v 1 -Cc -c public %(printer)s | grep mib-2.43.10.2.1.4.1.1 | cut -d " " -f4)
646# accounter : hardware(/opt/local/net-snmp/bin/snmpwalk -v 1 -Cc -c public -Ov %(printer)s | grep Counter32 | tail -2 | head -1 | cut -d " " -f2)
647# accounter : software(/usr/bin/pkpgcounter)
648# accounter : software()
649# accounter : ink(cmyk, 150)
650# accounter : ink(bw, 300)
651# accounter : ink(bw)
652# accounter : ink(cmy, 72)
653# accounter : ink(gc, 72)
654#         
655# This directive can be set either globally or per printer or both.
656# If both are defined, the printer option has priority.
657#         
658# IF YOU PLAN TO USE YOUR OWN SCRIPTS FOR HARDWARE ACCOUNTING,     
659# YOU ABSOLUTELY HAVE TO BE SURE YOU HAVE A SCRIPT WHICH WAITS FOR THE
660# PRINTER BEING READY BEFORE ASKING FOR ITS INTERNAL PAGE COUNTER.
661#         
662# PYKOTA'S 'snmp' and 'pjl' HARDWARE ACCOUNTING METHODS DO THE CORRECT WORK
663# INTERNALLY, BUT SOME OF THE EXAMPLES ABOVE DON'T, YOU HAVE BEEN WARNED.
664#
665# WITH THE SPECIAL MAGIC hardware(snmp) AND hardware(pjl) VALUES, PYKOTA
666# TAKES CARE OF ALL THIS FOR YOU, SO PLEASE UNDERSTAND THAT IT IS PREFERABLE
667# TO USE THESE TWO METHODS : THEY WORK FINE, REQUIRE LITTLE TO NO CPU,
668# AND DO ALL THE HARD WORK AUTOMATICALLY. IF YOU REALLY NEED TO YOU CAN USE
669# YOUR OWN EXTERNAL COMMANDS AS DESCRIBED ABOVE, JUST BE CAREFUL WITH THIS.
670#         
671# Sane default :
672#
673accounter: software()
674
675# Should we ensure that the printer really is idle before
676# sending the job's datas to it ?
677#
678# This directive is only used when you use an internal
679#�hardware accounting mechanism, like hardware(snmp) or
680# hardware(pjl), and is not used for external hardware
681# accounting mechanisms or for software or ink accounting.
682#
683# If PyKota and CUPS are properly configured, i.e. a single
684# computer (the print server) can access to a particular physical
685# printer, or all CUPS+PyKota print servers which access to the
686# same physical printer share a common network directory used
687# by PyKota to lock this printer resource, then it is not necessary
688# to really ensure the printer is idle before the job, because
689# this is already the case : we already wait at the end of the
690# preceding job for the printer to be idle before reading its
691# internal page counter. So setting this value to Yes usually
692# saves a lot of time between jobs, generally around 30 seconds.
693#
694# If you're not sure, leave this value to the default which is No,
695# meaning that before sending the job's datas to the printer, PyKota
696# will ensure this printer is in idle state.
697#
698# If not defined, a value of No is assumed.
699#
700# This value can be set either globally or on a per printer basis
701# If both are defined, the printer option has priority.
702#
703# Sane default :
704#
705skipinitialwait : no
706
707# What is the "pre"-accounter used for precomputing the job's size.
708#
709# Supported values are :
710#
711#  preaccounter: software()       
712#  preaccounter: software(/path/to/your/script)
713#  preaccounter: ink(colorspace, resolution)
714#
715# NB : the preaccounter directive doesn't support hardware() for obvious
716# reasons. If unset, "software()" is assumed. If you use your own script,
717# ensure that it only prints the job's number of pages (or an estimation
718# of it) on its standard output.
719#
720# You may want to define for example 'preaccounter : software(/bin/echo 1)'
721# in the case your printer supports an hardware accounter but pkpgcounter
722# can't parse your printer driver's datas.
723#
724# Supported colorspaces for ink accounting currently are :
725#
726#       bw      ===> Black & White
727#       cmyk    ===> Cyan, Magenta, Yellow, Black
728#       cmy     ===> Cyan, Magenta, Yellow
729#       rgb     ===> Red, Green, Blue
730#       gc      ===> Grayscale, Colored : this is a pseudo colorspace useful
731#                    if all you need is differentiating grayscale from
732#                    colored pages.
733#
734# Supported resolutions for ink accounting are any number of dots
735# per inch comprised between 72 and 1200.
736# IMPORTANT : increasing the resolution increases precision, but
737# increase CPU load a lot at the same time. The default resolution
738# if unset is 72, for 72 dpi.
739#
740# This value can be set either globally or on a per printer basis
741# If both are defined, the printer option has priority.
742#
743# Sane default :
744#
745preaccounter: software()
746
747
748
749# What should we do if the accounter's subprocess doesn't return
750# a valid result (for example doesn't return an integer on its stdout)
751#
752# Valid values are : 'continue' and 'stop'. 'stop' is the default
753# if unset.
754#
755# 'continue' means try to process as usual, this may introduce
756# accounting errors and free jobs. This was the default behavior
757# until v1.20alpha5.
758#
759# 'stop' means fail and stop the print queue. If an accounter
760# error occurs, most of the time this is a misconfiguration, so
761# stopping the print queue is usually the better thing to do
762# until the admin has fixed the configuration.
763#
764# This value can be set either globally or on a per printer basis
765# If both are defined, the printer option has priority.
766#
767# NB : This directive shouldn't do much now because in case
768# of external accounter error, PyKota just loops.
769#
770# onaccountererror: continue
771onaccountererror: stop
772
773
774
775# Print Quota administrator
776# These values can be set either globally or per printer or both.
777# If both are defined, the printer option has priority.
778# If these values are not set, the default admin root
779# and the default adminmail root@localhost are used.
780admin: John Doe
781adminmail: root@localhost
782
783
784
785# Who should we send an email to in case a quota is reached ?
786# possible values are : DevNull, User, Admin, Both, External(some command)
787# The Both value means that the User and the Admin will receive
788# an email message.
789# The DevNull value means no email message will be sent.
790# This value can be set either globally or per printer or both.
791# If both are defined, the printer option has priority.
792# If the value is not set, then the default BOTH applies.
793#
794#   Format of the external syntax :
795#
796#       mailto: external(/usr/bin/mycommand >/dev/null)
797#
798#   You can use :
799#
800#       '%(action)s'            will contain either WARN or DENY
801#       '%(username)s'          will contain the user's name
802#       '%(printername)s'       will contain the printer's name
803#       '%(email)s'             will contain the user's email address
804#       '%(message)s'           will contain the message if you want
805#                               to use it.
806#
807#   on your command line, to pass arguments to your command.
808#   Examples :
809#
810#     mailto: external(/usr/bin/callpager %(username)s "Quota problem on %(printername)s" >/dev/null)
811#
812#   To automatically send a WinPopup message (this may only work with a PDC,
813#   here the same machine does Samba as PDC + CUPS) :
814#
815#     mailto: external(echo "%(message)s" | /usr/bin/iconv --to-code utf-8 --from-code iso-8859-15 | /usr/bin/smbclient -M "%(username)s" 2>&1 >/dev/null)
816#
817#   NB : I use ISO-8859-15, but Windows expects UTF-8, so we pipe the message
818#        into iconv before sending it to the Windows user.
819#
820# or more simply :
821#
822#     mailto: external(/usr/share/pykota/mailandpopup.sh %(username)s %(printername)s "%(email)s" "%(message)s" 2>&1 >/dev/null)
823#
824#   NB : The mailandpopup.sh shell script is now included in PyKota
825#
826#   NB : in ANY case, don't forget to redirect your command's standard output
827#        somewhere (e.g. >/dev/null) so that there's no perturbation to the
828#        underlying layer (filter or backend)
829#
830mailto : both
831
832
833
834# The value of the zero for account balance limitations.
835# If a user is limited by balance, he can print until
836# his balance reaches the value defined here. If unset,
837# the default value is 0. Any floating point value
838# is accepted.
839# You'll want to use this to give free credits to your users
840# at the start of the year for example.
841#
842# This option can only appear in the global section
843#
844# balancezero : -0.25
845#
846balancezero: 0.0
847
848
849
850# Grace delay in days
851# This value can be set either globally or per printer or both.
852# If both are defined, the printer option has priority.
853# If the value is not set then the default seven (7) days applies.
854#
855gracedelay : 7
856
857
858
859# Poor man's threshold
860# If account balance reaches below this amount, a warning message
861# is sent through the 'mailto' directive above.
862#
863# If unset, default poor man's threshold is 1.0.
864# This option can only appear in the global section
865#
866poorman : 1.0
867
868
869
870# Poor man's warning message
871# The warning message that is sent if the "poorman" value is reached
872# Again this must appear in the global section
873#
874poorwarn : Your Print Quota account balance is low.
875 Soon you'll not be allowed to print anymore.
876
877
878
879# Soft limit reached warning message
880# The warning message that is sent if the soft quota limit is reached
881# May appear either globally or on a per-printer basis
882#
883softwarn: Your Print Quota Soft Limit is reached.
884 This means that you may still be allowed to print for some
885 time, but you must contact your administrator to purchase
886 more print quota.
887
888
889
890# Hard limit reached error message
891# The error message that is sent if the hard quota limit is reached
892# May appear either globally or on a per-printer basis
893#
894hardwarn: Your Print Quota Hard Limit is reached.
895 This means that you are not allowed to print anymore.
896 Please contact your administrator at root@localhost
897 as soon as possible to solve the problem.
898
899
900
901# Default policy to apply when either :
902#
903#       - Printer doesn't exist in PyKota's database
904#       - User doesn't exist in PyKota's database
905#       - User has no quota entry for this Printer in PyKota's database
906#
907# Value can be either 'allow' or 'deny' or 'external(some command here)'
908#
909# 'Allow' means that the job will be printed even if the printer, the
910# user or this user's print quota entry on this printer doesn't exist
911# in PyKota's database. But the job won't appear in the printing history.
912#
913# 'Deny' means the job will be rejected if any of these three conditions
914# is met.
915#
916# 'External' means any command of your choice will be launched if any
917# of these three conditions is met. Once your command has ended, PyKota
918# will try again to retrieve the printer, user or user's print quota
919# entry from its database. If it fails to find any of them again, the
920# job will be rejected.
921#
922# This value can be set either globally or per printer or both.
923# If both are defined, the printer option has priority.
924# If the value is not set then the default policy DENY applies.
925# There's no policy wrt inexistant groups, they are ignored.
926#
927# external policy can be used to launch any external command of your choice,
928# for example to automatically add the user to the quota database, and set
929# page limits on the current printer if he is unknown :
930#
931#   policy: external(/usr/bin/pkusers --add --skipexisting %(username)s && /usr/bin/edpykota --add --skipexisting --printer %(printername)s --softlimit 50 --hardlimit 60 %(username)s)
932#
933# NB : If you want to limit users by their account balance value, it is preferable to
934# use the following policy to automate user account creation on first print :
935#
936#   policy: external(/usr/bin/autopykota --initbalance 25.0)
937#
938#   This will automatically add the user if he doesn't already exist, and
939#   set his initial balance value to 25.0 (for example). If the user already
940#   exists then his balance value will not be modified.
941#   Please don't use autopykota if you want to limit your users by page
942#   quota, and in any case, carefully read autopykota's help or manpage
943#   and understand its goal before using it in your own configuration.
944#
945# Of course you can launch any command of your choice with this, e.g. :
946#
947#   policy: external(/usr/local/bin/myadminscript.sh %(username)s)
948#
949# You can use :
950#
951#       '%(username)s'          will contain the user's name
952#       '%(printername)s'       will contain the printer's name
953#
954#   On your command line, to pass arguments to your command.
955#
956# If the printer, user, or user quota entry still doesn't exist after
957# external policy command was launched (the external command didn't add it),
958# or if an error occured during the execution of the external policy
959# command, then the job is rejected.
960#
961# By default, we reject all jobs from users not in the database :
962#
963policy: deny
964
965
966
967# Pre and Post Hooks
968# These directives allow the easy plug-in of any command of your choice
969# at different phases of PyKota's execution.
970# Pre and Post Hooks can access some of PyKota's internal information
971# by reading environment variables as described below.
972# The actual phase of PyKota's execution is available in the
973# PYKOTAPHASE environment variable.
974# Pre and Post Hooks can be defined either globally, per printer,
975# or both. If both are defined, the printer specific hook has
976# priority.
977#
978# List of available environment variables :
979# NB : Most of these variables are also available during the execution
980# of external commands defined in the accounter and mailto
981# directives.
982#
983# PYKOTADIRECTORY : The directory containing cupspykota's temporary files
984# PYKOTADATAFILE : The name of the temporary file which contains the
985#                  job's datas
986# PYKOTAFILENAME : The name of the file which contains the job's datas or
987#                  empty if datas come from stdin
988# PYKOTACONTROLFILE : The name of the IPP message file
989# PYKOTAMD5SUM : Contains an hexadecimal digest of the md5 sum of the job's datas
990# PYKOTAPHASE : BEFORE or AFTER the job is sent to the printer
991# PYKOTAACTION : ALLOW or DENY or WARN for current print job
992# PYKOTAUSERNAME : user's name, possibly modified through the overwrite_jobticket directive.
993# PYKOTAORIGINALUSERNAME : user's name, unmodified.
994# PYKOTAPRINTERNAME : printer's name
995# PYKOTAPGROUPS : list of printers groups the current printer is a member of
996# PYKOTAJOBID : job's id
997# PYKOTATITLE : job's title
998# PYKOTACOPIES : number of copies
999# PYKOTAOPTIONS : job's options
1000# PYKOTABALANCE : user's account balance
1001# PYKOTALIFETIMEPAID : user's grand total paid
1002# PYKOTALIMITBY : user print limiting factor, for example 'quota' or 'balance'
1003# PYKOTAPAGECOUNTER : user's page counter on this printer
1004# PYKOTALIFEPAGECOUNTER : user's life time page counter on this printer
1005# PYKOTASOFTLIMIT : user's soft page limit on this printer
1006# PYKOTAHARDLIMIT : user's hard page limit on this printer
1007# PYKOTADATELIMIT : user's soft to hard limit date limit on this printer
1008# PYKOTASTATUS : contains "CANCELLED" when SIGTERM was received by PyKota
1009#                else is not set.
1010# PYKOTAJOBSIZEBYTES : contains the job's size in bytes. Always available.
1011# PYKOTAPRECOMPUTEDJOBSIZE : contains the precomputed job's size
1012# PYKOTAPRECOMPUTEDJOBPRICE : contains the precomputed job's price
1013# PYKOTAJOBORIGINATINGHOSTNAME : contains the client's hostname if
1014#                                it is possible to retrieve it.
1015# PYKOTAPRINTERHOSTNAME : the printer's hostname or IP address for network
1016#                         printers, or "localhost" if not defined or not
1017#                         meaningful.
1018# PYKOTAWARNCOUNT : the number of times the user was forbidden to print but a banner
1019#                   page was still printed on the current printer.                   
1020# PYKOTAOVERCHARGE : user's overcharging factor.
1021# PYKOTAJOBBILLING : Job's billing code if present, possibly modified through the overwrite_jobticket directive.
1022# PYKOTAORIGINALJOBBILLING : Job's billing code if present, unmodified.
1023# PYKOTAREASON : if the job was denied or a warning needs to be issued, contains
1024#                the message to send to the user.
1025# PYKOTAUSERDESCRIPTION : the user's textual description
1026# PYKOTAPRINTERDESCRIPTION : the printer's textual description
1027# PYKOTAPRINTERPASSTHROUGHMODE : the printer's passthrough mode
1028# PYKOTAPRINTERMAXJOBSIZE : the printer's maximal job size
1029# PYKOTAPRICEPERJOB : the printer's price per job
1030# PYKOTAPRICEPERPAGE : the printer's price per page
1031#
1032
1033
1034# PreHook : gets executed after being sure the user, printer and user quota
1035# entry on the printer both exist in the PyKota database, and after
1036# checking if the user is allowed to print or not, but just before
1037# the job is sent to the printer (if allowed)
1038# prehook has access to many environment variables :
1039#
1040# PYKOTAACTION contains either "ALLOW", "WARN" or "DENY" and
1041# represents the action which is to be done wrt the print job.
1042# PYKOTAPHASE contains 'BEFORE' during execution of prehook
1043#
1044# uncomment the line below to see what environment variables are available
1045# prehook: /usr/bin/printenv >/tmp/before
1046
1047
1048
1049# PostHook : gets executed after the job has been added to the history.
1050# posthook has access to all the environment variables defined above,
1051# as well as two additionnal environment variables : PYKOTAJOBPRICE
1052# and PYKOTAJOBSIZE.
1053# PYKOTAPHASE contains 'AFTER' during execution of posthook.
1054#
1055# uncomment the line below to see what environment variables are available
1056# posthook: /usr/bin/printenv >/tmp/after
1057
1058
1059
1060# AccountBanner : how should banner accounting be done ?
1061#
1062# If enabled, banner pages printed from StartingBanner and/or EndingBanner
1063# (depending on the value) will be included in the accounting for the
1064# print job
1065#
1066# If disabled, banner pages printed from StartingBanner and EndingBanner will
1067# *not* be included in the accounting for the print job
1068#
1069# IMPORTANT : CUPS generated banners are ALWAYS accounted for, although you
1070#             can refund them by using negative prices on printers.
1071#
1072# Allowed values : Starting | Ending | None | Both
1073#
1074#       - Starting : only the starting banner will be accounted for.
1075#       - Ending : only the ending banner will be accounted for.
1076#       - Both : both starting and ending banners will be accounted for.
1077#       - None : banners will not be accounted for.
1078#
1079# Default value :
1080# accountbanner: Both
1081
1082
1083
1084# Maximal number of times the banner will still be printed if
1085# the user is forbidden to print.
1086#
1087# This option can be set either globally or on a per printer basis.
1088# Allowed values are 0 or any positive integer.
1089# Default value is 0, which means that the banner won't be printed
1090# at all if the user is forbidden to print.
1091#
1092maxdenybanners: 0
1093
1094
1095
1096# If a job is cancelled, should any start or end banners still be printed
1097#
1098# This option can be set either globally or on a per printer basis.
1099# If set to yes, any defined banners will be printed
1100# If set to no, no banners will be printed
1101#
1102# This value defaults to yes
1103# printcancelledbanners: yes
1104
1105
1106# If a job is printed by the same person as the last job on the same printer,
1107# should banners be avoided to save some paper
1108#
1109# This option can be set either globally or on a per printer basis.
1110# If set to yes, any duplicate banners will be avoided forever
1111# If set to no or 0, no banners will be avoided (they will all be printed)
1112# If set to any positive integer, banners will be avoided if printed within
1113#     'integer' seconds of the last job
1114#
1115# This value defaults to no
1116# avoidduplicatebanners: yes
1117# avoidduplicatebanners: no
1118# avoidduplicatebanners: 600   
1119
1120
1121# StartingBanner : if defined will print a banner before the rest of the job
1122# is printed. The argument can be a printable file, or an executable file.
1123# If not executable, the file will be printed as is. If executable, the
1124# file will be executed and its standard output will be sent to the printer.
1125#
1126# In any case, the banner content which will be sent to the printer
1127# MUST be in a format your printer will accept !!!
1128#
1129# The pkbanner command included in PyKota can automatically generate
1130# starting and ending banners in the PostScript format. You can use
1131# this command in a pipe through GhostScript if your printer doesn't
1132# accept PostScript as an input format.
1133# NB : pkbanner's default page size is A4
1134#
1135# startingbanner: /home/joe/mystaticbanner.ps
1136# startingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com"
1137# startingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono -
1138# startingbanner: /usr/bin/pkbanner
1139
1140
1141
1142# EndingBanner : if defined will print a banner after the job
1143# has been printed. The argument can be a printable file, or an executable file.
1144# If not executable, the file will be printed as is. If executable, the
1145# file will be executed and its standard output will be sent to the printer.
1146#
1147# In any case, the banner content which will be sent to the printer
1148# MUST be in a format your printer will accept !!!
1149#
1150# The pkbanner command included in PyKota can automatically generate
1151# starting and ending banners in the PostScript format. You can use
1152# this command in a pipe through GhostScript if your printer doesn't
1153# accept PostScript as an input format.
1154# NB : pkbanner's default page size is A4
1155#
1156# A static banner page
1157# endingbanner: /home/joe/mystaticbanner.ps
1158#
1159# A banner with personnalized logo and url
1160# endingbanner: /usr/bin/pkbanner --pagesize=A4 --logo="/home/joe/mylogo.jpeg" --url="http://tech.example.com"
1161#
1162# A banner in the format accepted by the printer
1163# endingbanner: /usr/bin/pkbanner | gs -q -dNOPAUSE -dBATCH -dPARANOIDSAFER -sOutputFile=- -sDEVICE=lj5mono -
1164#
1165# A banner with more info on it, extracted from the yellow pages.
1166# the string "Phone 111222333444" will be added to the banner page
1167# if extractphone.sh returns 111222333444 for the current user.
1168# endingbanner: /usr/bin/pkbanner Phone `extractphone.sh $PYKOTAUSERNAME`
1169#
1170# Default PyKota banner
1171# endingbanner: /usr/bin/pkbanner
1172
1173
1174
1175# How should enforcement be done for this printer ?
1176#
1177# "laxist" is the default if value is not set, and allows users
1178# to be over quota on their last job.
1179#
1180# "strict" tries to prevent users from ever being over quota.
1181#
1182# Enforcement can be defined either globally, per printer,
1183# or both. If both are defined, the printer specific enforcement
1184# setting has priority.
1185#
1186# valid values : "strict" or "laxist"
1187#
1188# default value when not set is "laxist"
1189#
1190# enforcement : laxist
1191enforcement : strict
1192
1193
1194
1195# Should we trust the job size on this printer ?
1196#
1197# "trustjobsize : yes" is the default, the jobsize, either computed
1198# by the hardware or by software is trusted.
1199#
1200# "trustjobsize : >N:precomputed" : uses the precomputed value
1201#                                   if jobsize > N pages
1202# "trustjobsize : >N:25" : uses 25 if jobsize is >N pages
1203#
1204# General form : ">n:m" where n is a positive integer, and m is
1205# either the word 'precomputed' or a positive integer.
1206# The special form "yes" is also accepted and is the default.
1207#
1208# This directive can be set either globally or on a per printer
1209# basis. Use this directive when hardware accounting for a particular
1210# printer produces some glitches due to the printer returning
1211# incorrect answers.
1212#
1213# NB : DON'T MODIFY THIS IF YOU DON'T NEED TO. THIS IS ONLY TO BE USED
1214# AS A WORKAROUND FOR SOME PRINTERS. IT'S PROBABLY BETTER TO ALWAYS
1215# SET THIS DIRECTIVE TO 'yes'. THIS DIRECTIVE WILL ONLY BE HONORED
1216# IF PYKOTA DETECTS A DIFFERENCE BETWEEN THE PRECOMPUTED JOB SIZE
1217# AND THE JOB SIZE AS COMPUTED BY PYKOTA EITHER USING HARDWARE OR
1218# SOFTWARE.
1219#
1220trustjobsize : yes
1221
1222
1223
1224# Should we deny duplicate jobs ?
1225#
1226# A duplicate is a job sent twice (or more) in a row to the same printer
1227# by the same user.
1228#
1229# This can be defined either globally or on a per printer basis
1230# The default value is 'no', meaning that duplicate jobs are
1231# allowed.
1232#
1233# NB : if an user prints a job, a second user prints another
1234#      job, and the first user prints the first job again,
1235#      this is NOT considered as a duplicate since the two
1236#      identical jobs printed by the first user are not
1237#      one just after the other.
1238#
1239# Possible values are 'yes', 'no', or any other string.
1240# If the string is not recognized as a truth value,
1241# it is considered to be a command to launch.
1242# PyKota launches the command and parses its standard
1243# output. The special keywords 'ALLOW' and 'DENY' are
1244# recognized, allowing an external tool to decide if
1245# the job is to be allowed or denied.
1246#
1247# denyduplicates : /usr/bin/myowncommand with some arguments
1248# denyduplicates : yes
1249denyduplicates : no
1250
1251
1252
1253# Sets the delay in seconds after which two identical jobs are
1254# not considered as being a duplicate.
1255#
1256# This can be defined either globally or on a per printer basis
1257# The default value if not set is 0, for 0 seconds.
1258# duplicatesdelay : 300
1259duplicatesdelay : 0
1260
1261
1262
1263# Sets the maximum number of seconds to wait for the printer
1264# being in 'printing' mode once the job has been sent to it.
1265# Once this delay is expired, PyKota will consider this job
1266# will never be printed, aborts the hardware accounting
1267# process, and uses the latest internal page counter value seen.
1268#
1269# Increasing this value, or setting it to 0, may help with some
1270# printers which don't conform to RFC3805. Problem reported on a
1271# Samsung ML2551n gave a way for clever students to bypass
1272# hardware accounting entirely by removing the paper from
1273# the paper tray before the job had begun to print, then
1274# waiting 60 seconds, and putting the paper back in the tray...
1275#
1276# IMPORTANT : always ensure that your printers' firmware is up
1277# to date.
1278#
1279# This directive can be set either globally or on a per printer
1280# basis.
1281#
1282# When not set, an hardcoded value of 60 seconds is used.
1283# When set to 0, PyKota will wait indefinitely until the
1284# printer switches to the 'printing' status.
1285noprintingmaxdelay : 60
1286
1287
1288
1289# Defines the number of times the 'idle' printer status
1290# has to be reported before it being considered stable.
1291# Each check is done every 'statusstabilizationdelay' seconds
1292# as defined below.
1293#
1294# This directive can be set either globally or on a per printer
1295# basis.
1296#
1297# When not set, an hardcoded value of 5 times is used.
1298# The value must be a strictly positive integer.
1299statusstabilizationloops : 5
1300
1301
1302
1303# Defines the number of seconds to wait between two consecutive
1304# checks of the printer's status when using hardware accounting.
1305#
1306# Each check is done up to 'statusstabilizationloops' times.
1307#
1308# This directive can be set either globally or on a per printer
1309# basis.
1310#
1311# When not set, an hardcoded value of 4.0 seconds is used.
1312# The value must be a positive floating point value greater
1313# than or equal to 0.25 seconds.
1314statusstabilizationdelay : 4.0
1315
1316
1317
1318# Defines a (16 bits) bit mask to specify the set of error conditions
1319# reported through SNMP for which PyKota has to wait indefinitely
1320# until such an error is fixed before continuing with printing
1321# and/or accounting.
1322#
1323# This directive can be set either globally or on a per printer
1324# basis.
1325#
1326# The 16 bit values are specified as in RFC3805 (Printer MIB v2),
1327# as an ORed value of one or more of the following conditions :
1328#
1329#       1000 0000 0000 0000 : Low Paper
1330#       0100 0000 0000 0000 : No Paper
1331#       0010 0000 0000 0000 : Low Toner
1332#       0001 0000 0000 0000 : No Toner
1333#       0000 1000 0000 0000 : Door Open
1334#       0000 0100 0000 0000 : Jammed
1335#       0000 0010 0000 0000 : Offline
1336#       0000 0001 0000 0000 : Service Requested
1337#       0000 0000 1000 0000 : Input Tray Missing
1338#       0000 0000 0100 0000 : Output Tray Missing
1339#       0000 0000 0010 0000 : Marker Supply Missing
1340#       0000 0000 0001 0000 : Output Near Full
1341#       0000 0000 0000 1000 : Output Full
1342#       0000 0000 0000 0100 : Input Tray Empty
1343#       0000 0000 0000 0010 : Overdue Preventive Maintainance
1344#       0000 0000 0000 0001 : Not assigned
1345#
1346# When not set, an hardcoded value of hexadecimal 0x4FCC is used,
1347# which means that PyKota will wait indefinitely when using SNMP
1348# hardware accounting if one of the following conditions is met :
1349#
1350#   No Paper, Door Open, Jammed, Offline, Service Requested,
1351#   Input Tray Missing, Output Tray Missing, Output Full, Input Tray Empty
1352#
1353# This value can be specified either in hexadecimal (prefixed with 0x),
1354# in octal (prefixed with 0) or in decimal (no prefix).
1355#
1356snmperrormask : 0x4FCC
1357
1358
1359
1360# Defines a set of coefficients for ink accounting.
1361#
1362# Each ink coefficient is the factor of the price per page
1363# you set with pkprinters which would represent the cost
1364# of a page covered at 100% with ink in this particular color.
1365#
1366# With these coefficients, the exact cost of each page
1367# can be computed : for each ink color in the colorspace specified
1368# in the preaccounter and/or accounter directives, we multiply the
1369# base cost per page set with pkprinters by this ink color's coefficient
1370# and by the percent of that page covered with such ink. Then we
1371# sum the values, and repeat the operation for each page. We then
1372# add the base cost per job set with pkprinters, and repeat
1373# the operation recursively in case of nested printers groups.
1374#
1375# The names of the coefficients you should set depend on the colorspace
1376# you want to use for ink accounting :
1377#
1378#       cmyk :
1379#               coefficient_cyan
1380#               coefficient_magenta
1381#               coefficient_yellow
1382#               coefficient_black
1383#
1384#       cmy :
1385#               coefficient_cyan
1386#               coefficient_magenta
1387#               coefficient_yellow
1388#
1389#       rgb :
1390#               coefficient_red
1391#               coefficient_green
1392#               coefficient_blue
1393#
1394#       bw :
1395#               coefficient_black
1396#
1397#       gc :
1398#               coefficient_grayscale
1399#               coefficient_colored
1400#
1401# Any coefficient which is not set is considered to be equal to 1.0
1402#
1403# Coefficients can be set either in the [global] section or in any
1404# [printqueuename] section. The latter taking precedence, as always.
1405#
1406#coefficient_cyan : 1.2
1407#coefficient_magenta : 3
1408#coefficient_yellow : 1.1
1409#coefficient_black : 1.0
Note: See TracBrowser for help on using the browser.