root / tea4cups / trunk / README @ 644

Revision 644, 5.4 kB (checked in by jerome, 19 years ago)

Removed all references to 'tees' from the sample configuration file
and documentation.
Updated the license because of the Free Software Foundation's new
snail mail address.
Reworded Peter's contributions in the CREDITS file.
Added missing copyright messages.

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