root / tea4cups / trunk / README @ 586

Revision 586, 3.5 kB (checked in by jerome, 14 years ago)

Added some doc on the available environment variables in the README

  • 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
35To help your own commands, Tea4CUPS makes available as part of the
36environment several variables which can be used as part of the
37commands you use :
38
39        TEAPRINTERNAME : The print queue name.
40        TEADIRECTORY : Tea4CUPS output directory.
41        TEADATAFILE : Full name of Tea4CUPS work file (in $TEADIRECTORY).
42        TEAJOBSIZE : Job's size in bytes.
43        TEAMD5SUM : MD5 sum of the job's datas.
44        TEACLIENTHOST : Client's hostname or IP address.
45        TEAJOBID : Job's Id.
46        TEAUSERNAME : Name of the user who launched the print job.
47        TEATITLE : Job's title.
48        TEACOPIES : Number of copies requested.
49        TEAOPTIONS : Options of the print job.
50        TEAINPUTFILE : Print job's data file or empty when job read from stdin.
51       
52=============================================================================
53
54Installation :
55--------------
56
57  1 - Copy the 'tea4cups' command into CUPS' backend directory,
58      for example :
59     
60        $ cp tea4cups /usr/lib/cups/backend
61       
62  2 - Restart CUPS in order for this new backend to be detected.       
63 
64  3 - Either from CUPS' web interface, add new printers with
65      'Tea4CUPS managed' in front of the device's name.
66         
67      Or by directly modifying CUPS' printers.conf file, prepend   
68      each DeviceURI value with 'tea4cups://', and restart CUPS.
69     
70  4 - Copy tea4cups.conf into CUPS' configuration directory (where   
71      cupsd.conf resides) :
72     
73        $ cp tea4cups.conf /etc/cups/
74       
75  5 - Modify tea4cups.conf to suit your needs. Several examples     
76      are included.
77     
78  6 - There's no 6 !   
79 
80=============================================================================
81
82Troubleshooting :
83-----------------
84
85  1 - Set "LogLevel debug2" in CUPS' cupsd.conf
86 
87  2 - Restart CUPS.
88 
89  3 - Set "debug: yes" in the [global] section of tea4cups.conf
90 
91  4 - Print something on a print queue managed
92      by Tea4CUPS.
93     
94  5 - Look at CUPS' error_log file for diagnostic and error messages.
95 
96=============================================================================
97   
98Please e-mail bugs to : alet@librelogiciel.com (Jerome Alet)
Note: See TracBrowser for help on using the browser.