root / tea4cups / trunk / README @ 608

Revision 603, 4.9 kB (checked in by jerome, 19 years ago)

Improved README file

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