~ubuntu-branches/debian/sid/foomatic-filters/sid

Viewing changes to .pc/0500-paps.patch/USAGE

Committer: Package Import Robot
Author(s): Jörg Frings-Fürst
Date: 2015-01-22 23:11:26 UTC
Revision ID: package-import@ubuntu.com-20150122231126-dou9xsfnau1vs9ho

Tags: 4.0.17-6

http://bugs.debian.org/769842

* New debian/patches/0500-paps.patch: cherry-pick from upstream to add paps
  as default filter that functional with utf-8 (Closes: #769842).
  Thanks to Stéphane Aulery <saulery@free.fr>
* debian/control:
  - Add paps as default filter to the Recommends of foomatic-filters.
  - Bump Standards-Version to 3.9.6 (no changes required).
  - Remove useless ${perl:Depends}.
  - Remove outdated Breaks and Replaces.
* debian/copyright:
  - Add year 2015.
  - Rewrite to correct the order.
* Remove debian/source/options because compression xz is standard now.

Show diffs side-by-side

added added

removed removed

.pc/0500-paps.patch/USAGE

Foomatic 4.0.17

===============

foomatic-filters

----------------

Filter scripts used by the printer spoolers to convert the incoming

PostScript data into the printer's native format using a

printer/driver specific, but spooler-independent PPD file.

Till Kamppeter <till.kamppeter@gmail.com>

Lars Uebernickel <larsuebernickel@gmx.de>

http://www.openprinting.org/

This usage documentation file is written by Till Kamppeter

Intro

-----

Foomatic is a database providing information about the usage of

printers with Unix-like operating systems (Linux, Solaris, ...).

The applications of these operating systems send PostScript or PDF to

the printer queues. Therefore one usually hands over the PostScript

directly to a PostScript printer (sometimes with some inserted

PostScript commands for options) or uses Ghostscript for generating

the data format the printer needs from PostScript or PDF input. This

is done by the printer spooler which also stores the data in a spool

directory when the printer is still occupied by another job, transmits

the data to a print server in the network, and so on.

The printer drivers for non-PostScript printers are either compiled

into Ghostscript, a plug-in for Ghostscript (e. g. IJS drivers), or

they are an extra filter which converts a generic bitmap generated by

Ghostscript into the printer's data format. For this the spooler has

to call complicated command lines of Ghostscript and the extra filter

(if needed). The user of a Unix-like operating system normally does

not see these command lines because an installation program takes

appropriate filter scripts and/or description files from a database

and assigns them to the printer queue.

Widely used databases were the RHS-Printfilters and the APS

filters. Their disadvantages were that they only supported one spooler

(LPD/LPRng) and only a small part of the driver's options (mostly page

size and resolution). Foomatic supports all options of the drivers and

all known spoolers (LPD, LPRng, GNUlpr, CUPS, Solaris LP, PPR, PDQ,

CPS, direct spooler-less printing). In addition, all known free

software printer drivers are supported. Foomatic also supports

printing of various non-PostScript/PDF file types for spoolers which

do not support these by themselves (LPD, LPRng, GNUlpr, spooler-less

printing). To enable this feature you need to have "a2ps", "enscript",

or "mpage" installed.

Another problem is that the way how to install queues, to print files,

and to handle jobs is very different with different spoolers. LPD for

example requires editing of configuration files for adding a queue,

whereas CUPS and PPR have specialized command line utilities. Foomatic

puts a layer between the applications and the spoolers so that one has

a common, spooler-independent command line interface for all spoolers,

so that switching of spoolers or administration of a network with

different spoolers gets much easier, because for the same operations

there are the same commands, independent of the spooler.

This command line interface can also be used as a base for

spooler-independent graphical frontends.

Installation

------------

Foomatic runs on all systems where one can run the Perl

interpreter and Ghostscript.

foomatic-filters needs the Perl interpreter for beh (Backend Error

Handler) and the test suite.

To build foomatic-rip you need a C compiler and its standard libraries.

To run beh (Backend Error Handler) or the test suite a Perl interpreter

(5.6.0 and newer) is needed.

To connect to remote printers with a non-CUPS printing system, you

need additional connectivity software (as "rlpr", "nc", "smbspool',

...). To print non-PostScript/PDF files with LPD, LPRng, GNUlpr, or

without spooler, you will need a2ps, enscript, mpage, or similar

filters which convert non-PostScript files to PostScript. a2ps,

enscript, and mpage will be automatically used by the scripts when

they are installed.

Download sources:

rlpr: http://freshmeat.net/projects/rlpr/ or

http://www.openprinting.org/download/printing/

netcat: http://freshmeat.net/projects/netcat/

This package does not require any other Foomatic package. it can be

used with PPD files downloaded from the OpenPrinting site, with

100

manufacturer-supplied PPDs for PostScript printers, and probably with

101

other PPD files.

102

103

For non-PostScript printers one also needs Ghostscript (5.50 or newer,

104

GPL Ghostscript 8.63 or newer highly recommended) and the appropriate

105

printer driver.

106

107

For drivers which have to be compiled into Ghostscript ("Execution

108

style: Ghostscript built-in" on the driver pages on the OpenPrinting

109

site) check with "gs -h" whether the driver is in your Ghostscript. If

110

not you need to compile the driver into your Ghostscript or use a

111

Ghostscript version which already contains it (preferably GPL

112

Ghostscript 8.63 or newer).

113

114

If the driver page says "Execution style: Uniprint", it is much

115

easier, check whether the appropriate ".upp" file is in one of the

116

directories listed under "Search path:" in the end of the "gs -h"

117

output. Copy the ".upp" file to one of these directories when it was

118

not there already.

119

120

The third type of driver is marked with "Execution style: Filter",

121

this means, that you have to install a filter executable in addition

122

to Ghostscript. Check with "which <name of the filter>" whether the

123

filter is already there, otherwise download and install the

124

appropriate package.

125

126

foomatic-filters can be installed using these commands (if you have

127

downloaded this package from the BZR repository, run

128

"./make_configure" at first, for that you will also need the

129

"autoconf" and "aclocal" utilities, "aclocal" is in the "automake"

130

package in some distributions):

131

132

./configure

133

make

134

make install

135

136

"make install" must be run as "root", the other commands can be run as

137

a normal user.

138

139

The "configure" script will auto-detect where the programs have to be

140

installed and where the Perl interpreter is located. If "configure"

141

fails because of something not being installed, do

142

143

rm -rf config.cache autom*.cache

144

145

before you run "configure" again (after installing the missing parts).

146

147

By default, foomatic-filters is installed into subdirectories of

148

/usr/local (e. g. /usr/local/bin/foomatic-rip), to get it into

149

subdirectories of /usr (/usr/bin/foomatic-rip), enter:

150

151

./configure --prefix=/usr --sysconfdir=/etc

152

make

153

make install

154

155

There are other things which can be adjusted by options on the

156

"configure" command line, enter "./configure --help" for more

157

info. You can also modify variables in the beginning of the "Makefile"

158

after running "configure", but note that every run of "configure"

159

re-creates the "Makefile".

160

161

You can also run Foomatic out of its source directory (for example

162

when you want to try it out, or when you don't have root

163

access). Therefore enter (can be done as a normal user):

164

165

./configure

166

make inplace

167

168

and enter the commands with "./" in the beginning

169

(e. g. "./foomatic-rip ...", "man ./foomatic-rip.1"). This also works

170

on a machine where a system-wide Foomatic is already installed.

171

172

In addition, if you do not use CUPS, you should install a utility to

173

make PostScript out of non-PostScript files, so that you can print

174

those non-PostScript files and also a list of available options using

175

the "docs" option. The supported utilities are "a2ps"

176

(http://www-inf.enst.fr/~demaille/a2ps/), "enscript"

177

(http://people.ssh.fi/mtr/genscript/), and "mpage"

178

(http://www.mesa.nl/pub/mpage). Recommended is "a2ps" because it

179

detects many file types (text, most image formats) and together with

180

ImageMagick (for images) and Ghostscript it converts them to

181

PostScript. The other tools convert only text files. The tool you have

182

installed is auto-detected by foomatic-rip and used automatically if

183

necessary. PPR needs this tool only for printing the option list, and

184

CUPS does not need it at all. PPR and CUPS use internal filters for

185

printing non-PostScript files.

186

187

If you have a printer or multi-function device from HP, install HPLIP from

188

189

http://hplipopensource.com/

190

191

before starting to set up printer queues with foomatic-filters. This

192

is needed for printing on certain USB devices and for scanning and

193

photo memory card access on all devices. It also adds maintenance

194

functionality for inkjets, reporting of ink or toner levels and

195

printer status, and also remote readout of the printers front-panel

196

LCD. CUPS is required as the printing system when HPLIP is used.

197

198

Note: The "hp" CUPS backend and "beh" (see below) cannot be used

199

together.

200

201

202

203

Setting up printers

204

-------------------

205

206

If you have "foomatic-db-engine" installed, see the USAGE file there.

207

208

If not, see, depending on your spooler:

209

210

CUPS:

211

212

http://www.openprinting.org/cups-doc.html

213

214

LPD, LPRng, GNUlpr:

215

216

http://www.openprinting.org/lpd-doc.html

217

218

PPR:

219

220

http://www.openprinting.org/ppr-doc.html

221

222

PDQ:

223

224

http://www.openprinting.org/pdq-doc.html

225

226

CPS:

227

228

http://www.tww.cx/cps.php

229

230

Direct, spooler-less printing:

231

232

http://www.openprinting.org/direct-doc.html

233

234

Usage of PPD files (for all spoolers):

235

236

http://www.openprinting.org/ppd-doc.html

237

238

239

240

beh - Backend Error Handler

241

---------------------------

242

243

A wrapper for CUPS backends to make error handling configurable

244

245

Usually, if a CUPS backend exits with an error status other than zero

246

(for example if a printer is not turned on or not reachable on the

247

network), CUPS disables the print queue and one can only print again

248

if a system administrator re-enables the queue manually. Even restarting

249

CUPS (or rebooting) does not re-enable disabled queues.

250

251

For system administrators this can get annoying, for newbie users

252

who are not aware of this problem it looks like that CUPS is severely

253

broken. They remove and re-install print queues, getting on the nerves

254

of distro install support, people, or even switch back to a proprietary

255

operating system.

256

257

This script makes the handling of such backend errors configurable, so

258

that the problem can easily be worked around. The new possibilities are:

259

260

- Let queues simply not being disabled. Simple approach, but job gets

261

lost.

262

263

- Repeat a given number of times.

264

265

- Repeat infinitely often, until the job gets finally through. This

266

is the standard of LPRng, and it eliminates loss of the job.

267

268

- The interval between two attemts to run the backend can also be

269

configured.

270

271

- Configuration is done independently for each print queue. So local

272

printers and network printers can be treated differently.

273

274

275

Usage:

276

277

Make sure "beh" is in the CUPS backend directory (usually

278

/usr/lib/cups/backend/) and world-readable and -executable. Restart

279

CUPS (usually "killall -HUP cupsd" or "/etc/init.d/cups restart"). If

280

all is correct "lpinfo -v" should have "beh" in its output.

281

282

Then activate "beh" for your print queue(s) with command(s) like this:

283

284

lpadmin -p <queue name> -E -v beh:/<dd>/<att>/<delay>/<originaluri>

285

286

with

287

<queue name>: The name of your print queue

288

<dd>: Don't Disable, if "1", beh always exits with zero

289

status, so the queue gets never disabled when the

290

original backend exits with an error. "0" carries

291

the error status of the last call of the backend

292

(after <att> retries) on to CUPS, so the queue

293

usually gets disabled.

294

<att>: Attempts, number of attempts to recall the backend

295

in case of an error. "0" means infinite retries. In

296

this case <dd> gets meaningless.

297

<delay>: Delay between two attempts to call the beckend, to

298

be given in seconds and as an integer number.

299

Meaningless if <att> is one.

300

<originaluri>: The original URI, which your queue had before. Can

301

be determined with "lpstat -v".

302

303

All parameters, especially, <dd>, <att>, and <delay> have always to

304

be specified, even if one of them is meaningless due to the setting of

305

the others.

306

307

beh works with every backend except the "hp" backend of HPLIP.

308

309

Example URIs:

310

311

beh:/1/3/5/socket://printer:9100

312

313

On the network printer with host name "printer" it is tried to access

314

3 times with 5 second delays between the attempts. If the job still

315

fails, the queue is not disabled (and the job discarded).

316

317

beh:/0/10/60/socket://printer:9100

318

319

Retry 10 times in one minute intervals, disable the queue when still

320

not succeeding.

321

322

beh:/1/0/60/usb://Brother/HL-5040%20series

323

324

On a Brother HL-5040 on the USB try infinitely often until the printer

325

comes back, in intervals of one minute. This way the job does not get

326

lost when the printer is turned off and one can intendedly delay

327

printing by simply switching off the printer. The ideal configuration

328

for desktop printers and/or home users.

Older »