[567] | 1 | # $Id$ |
---|
| 2 | |
---|
[576] | 3 | Tea4CUPS : Tee for CUPS |
---|
[567] | 4 | |
---|
[612] | 5 | (c) 2005 Jerome Alet <alet@librelogiciel.com> |
---|
[567] | 6 | This program is free software; you can redistribute it and/or modify |
---|
| 7 | it under the terms of the GNU General Public License as published by |
---|
| 8 | the Free Software Foundation; either version 2 of the License, or |
---|
| 9 | (at your option) any later version. |
---|
| 10 | |
---|
| 11 | This program is distributed in the hope that it will be useful, |
---|
| 12 | but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 13 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 14 | GNU General Public License for more details. |
---|
| 15 | |
---|
| 16 | You should have received a copy of the GNU General Public License |
---|
| 17 | along with this program; if not, write to the Free Software |
---|
| 18 | Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA. |
---|
| 19 | |
---|
| 20 | ============================================================================= |
---|
| 21 | |
---|
[576] | 22 | Tea4CUPS is the equivalent of the *nix command 'tee', but as a CUPS |
---|
[567] | 23 | backend. |
---|
| 24 | |
---|
[576] | 25 | Tea4CUPS behaves just like any other CUPS backend, but allows you to |
---|
[567] | 26 | transparently send print jobs' datas to any number of outputs : other |
---|
| 27 | CUPS backends, files or pipes. |
---|
| 28 | |
---|
| 29 | This for example allows you to output the same print job on several |
---|
| 30 | printers at the same time, which is not possible with CUPS. |
---|
| 31 | |
---|
| 32 | Another possibility would be for example to send the same document to |
---|
| 33 | a printer, a PDF generator, a Fax, and as an attachment to an email |
---|
| 34 | message, all of this by printing it a single time. |
---|
| 35 | |
---|
[598] | 36 | Tea4CUPS provides three ways to launch commands : |
---|
| 37 | |
---|
| 38 | - prehooks : these are guaranteed to be launched before the |
---|
| 39 | print job is sent to the real printer. |
---|
[603] | 40 | Any prehook which exits -1 can cancel the |
---|
| 41 | print job. |
---|
[598] | 42 | |
---|
| 43 | - tees : these are launched at the same time the job is being |
---|
[603] | 44 | sent to the real printer, unless the job was |
---|
| 45 | previously cancelled by a prehook. |
---|
[598] | 46 | |
---|
| 47 | - posthooks : these are guaranteed to be launched after the |
---|
[603] | 48 | print job has been sent to the real printer, |
---|
| 49 | unless the job was previously cancelled by a |
---|
| 50 | prehook. |
---|
[598] | 51 | |
---|
[586] | 52 | To help your own commands, Tea4CUPS makes available as part of the |
---|
| 53 | environment several variables which can be used as part of the |
---|
| 54 | commands you use : |
---|
| 55 | |
---|
| 56 | TEAPRINTERNAME : The print queue name. |
---|
| 57 | TEADIRECTORY : Tea4CUPS output directory. |
---|
| 58 | TEADATAFILE : Full name of Tea4CUPS work file (in $TEADIRECTORY). |
---|
| 59 | TEAJOBSIZE : Job's size in bytes. |
---|
| 60 | TEAMD5SUM : MD5 sum of the job's datas. |
---|
| 61 | TEACLIENTHOST : Client's hostname or IP address. |
---|
| 62 | TEAJOBID : Job's Id. |
---|
| 63 | TEAUSERNAME : Name of the user who launched the print job. |
---|
| 64 | TEATITLE : Job's title. |
---|
| 65 | TEACOPIES : Number of copies requested. |
---|
| 66 | TEAOPTIONS : Options of the print job. |
---|
| 67 | TEAINPUTFILE : Print job's data file or empty when job read from stdin. |
---|
[598] | 68 | TEASTATUS : Original CUPS backend's exit code : ONLY AVAILABLE FROM |
---|
[603] | 69 | posthooks, obviously. |
---|
[586] | 70 | |
---|
[590] | 71 | In the case you want to use both Tea4CUPS and PyKota, you MUST install |
---|
| 72 | PyKota v1.22alpha2 or higher to avoid a race condition. |
---|
| 73 | |
---|
[567] | 74 | ============================================================================= |
---|
| 75 | |
---|
| 76 | Installation : |
---|
| 77 | -------------- |
---|
| 78 | |
---|
[591] | 79 | 0 - Download Tea4CUPS from : |
---|
| 80 | |
---|
| 81 | http://www.librelogiciel.com/software/Tea4CUPS/action_Presentation |
---|
| 82 | |
---|
[592] | 83 | and extract it : |
---|
| 84 | |
---|
| 85 | $ tar -zxf tea4cups-x.yy.tar.gz |
---|
| 86 | |
---|
| 87 | where x.yy is Tea4CUPS' version number. |
---|
| 88 | |
---|
[576] | 89 | 1 - Copy the 'tea4cups' command into CUPS' backend directory, |
---|
[567] | 90 | for example : |
---|
| 91 | |
---|
[576] | 92 | $ cp tea4cups /usr/lib/cups/backend |
---|
[567] | 93 | |
---|
| 94 | 2 - Restart CUPS in order for this new backend to be detected. |
---|
| 95 | |
---|
| 96 | 3 - Either from CUPS' web interface, add new printers with |
---|
[576] | 97 | 'Tea4CUPS managed' in front of the device's name. |
---|
[567] | 98 | |
---|
| 99 | Or by directly modifying CUPS' printers.conf file, prepend |
---|
[576] | 100 | each DeviceURI value with 'tea4cups://', and restart CUPS. |
---|
[567] | 101 | |
---|
[576] | 102 | 4 - Copy tea4cups.conf into CUPS' configuration directory (where |
---|
[567] | 103 | cupsd.conf resides) : |
---|
| 104 | |
---|
[576] | 105 | $ cp tea4cups.conf /etc/cups/ |
---|
[567] | 106 | |
---|
[576] | 107 | 5 - Modify tea4cups.conf to suit your needs. Several examples |
---|
[567] | 108 | are included. |
---|
| 109 | |
---|
| 110 | 6 - There's no 6 ! |
---|
| 111 | |
---|
| 112 | ============================================================================= |
---|
| 113 | |
---|
| 114 | Troubleshooting : |
---|
| 115 | ----------------- |
---|
| 116 | |
---|
| 117 | 1 - Set "LogLevel debug2" in CUPS' cupsd.conf |
---|
| 118 | |
---|
| 119 | 2 - Restart CUPS. |
---|
| 120 | |
---|
[576] | 121 | 3 - Set "debug: yes" in the [global] section of tea4cups.conf |
---|
[567] | 122 | |
---|
| 123 | 4 - Print something on a print queue managed |
---|
[576] | 124 | by Tea4CUPS. |
---|
[567] | 125 | |
---|
| 126 | 5 - Look at CUPS' error_log file for diagnostic and error messages. |
---|
| 127 | |
---|
| 128 | ============================================================================= |
---|
[591] | 129 | |
---|
| 130 | CUPS (Common UNIX(r) Printing System) is trademark property of Easy Software |
---|
| 131 | Products. |
---|
| 132 | |
---|
| 133 | You can download CUPS from : |
---|
| 134 | |
---|
| 135 | http://www.cups.org |
---|
| 136 | |
---|
| 137 | ============================================================================= |
---|
[567] | 138 | |
---|
| 139 | Please e-mail bugs to : alet@librelogiciel.com (Jerome Alet) |
---|