NOM
filter - Interface pour des filtres de conversion de fichiers pour
CUPS.
SYNOPSIS
filter travail utilisateur titre copies options [ fichier ]
Les filtres CUPS offrent la possibilité de gérer avec CUPS des nouveaux
types de documents. Chaque filtre est capable de convertir des fichiers
de différents formats dans un format qui est soit géré directement par
CUPS ou qui peut être envoyé à un autre filtre afin d'être imprimable.
Les filtres doivent être capables de lire depuis un fichier fournit sur
la ligne de commande ou depuis l'entrée standard, en copiant l'entrée
standard vers un fichier temporaire si nécessaire pour ce format de
fichier. Toutes les sorties doivent être envoyées sur la sortie
standard.
The command name (argv[0]) is set to the name of the destination
printer but is also available in the PRINTER environment variable.
OPTIONS
Options passed on the command-line typically do not include the default
choices the printer's PPD file. In addition, some options may be
specified in multiple ways - "landscape" is a synonym for
"orientation-requested=4", "media" is a synonym for "PageSize",
"PageRegion", "InputSlot", and "MediaType", and "sides" is a synonym
for the various "Duplex" options. Non-raster filters must support both
explicit and implicit specification of PPD options - use the
ppdMarkDefaults and cupsMarkOptions functions in the CUPS library to
use the correct mapping, and ppdFindMarkedChoice to get the
user-selected choice.
Raster filters should use option choices set through the raster page
header, as those reflect the options in effect for a given page.
Options specified on the command-line determine the default values for
the entire job, which can be overridden on a per-page basis.
MESSAGES JOURNALISES
Les messages envoyés à la sortie d'erreur sont généralement enregistrés
dans l'attribut printer-state-message et dans le journal ErrorLog
actuel. Chaque ligne commence par un préfixe standard :
ALERT: message
Définir l'attribut printer-state-message et ajouter le message
donné au journal ErrorLog actuel en utilisant le niveau de
journalisation "alert".
ATTR: attribut=valeur [attribut=valeur]
Définir l'attribut (les attributs) du travail d'impression nommé.
Typiquement, c'est utilisé pour fixer l'attribut job-remote-id.
CRIT: message
Définir l'attribut printer-state-message et ajouter le message
spécifié au journal ErrorLog actuel en utilisant le niveau de
journalisation "critical".
DEBUG: message
Définir l'attribut printer-state-message et ajouter le message
spécifié au journal ErrorLog actuel en utilisant le niveau de
journalisation "debug".
DEBUG2: message
Définir l'attribut printer-state-message et ajouter le message
spécifié au journal ErrorLog actuel en utilisant le niveau de
journalisation "debug2".
EMERG: message
Définir l'attribut printer-state-message et ajouter le message
spécifié au journal ErrorLog actuel en utilisant le niveau de
journalisation "emergency" (urgence).
ERROR: message
Définir l'attribut printer-state-message et ajouter le message
spécifié au journal ErrorLog actuel en utilisant le niveau de
journalisation "error".
INFO: message
Fixer l'attribut printer-state-message. Si LogLevel vaut debug2 ,
le message est également ajouté au journal ErrorLog en utilisant
le niveau "info".
NOTICE: message
Définir l'attribut printer-state-message et ajouter le message
spécifié au journal ErrorLog actuel en utilisant le niveau de
journalisation "notice".
PAGE: numéro_page #-copies
PAGE: total #-pages
Ajouter une entrée au fichier PageLog actuel. La première forme
ajoute le nombre de copies à l'attribut job-media-sheets-completed
La seconde expression renseigne au nombre de pages l'attribut
job-media-sheets-completed.
PPD: Keyword=Value ... KeywordN=Value
Sets the named keywords in the printer's PPD file. This is
typically used to update default option keywords such as
DefaultPageSize and the various installable options in the PPD
file.
STATE: raison-état-imprimante [raison-état-imprimante ...]
STATE: + raison-état-imprimante [raison-état-imprimante ...]
STATE: - raison-état-imprimante [raison-état-imprimante ...]
Définir, ajouter ou retirer de la file d'attente en cours un ou
plusieurs mots-clés « reason-state-printer ». Typiquement, cela
est utilisé pour indiquer l'état du média, de l'encre et du toner
d'une imprimante.
WARNING: message
Définir l'attribut printer-state-message et ajouter le message
spécifié au journal ErrorLog actuel en utilisant le niveau de
journalisation "warning".
VARIABLES D'ENVIRONNEMENT
Les variables d'environnement suivantes sont définies par le serveur
CUPS pour l'exécution des filtres :
CHARSET
Définir le jeu de caractères par défaut à utiliser pour les
textes, typiquement utf-8.
CLASS
Quand un travail est soumis à une classe d'imprimantes, elle
contient le nom de la classe d'imprimante. Sinon, cette variable
d'environnement n'est pas définie.
CONTENT_TYPE
Le type MIME associé au fichier (par exemple
application/postscript).
CUPS_CACHEDIR
The directory for semi-persistent cache files can be found.
CUPS_DATADIR
Le répertoire où se trouvent les fichiers de données.
CUPS_FILETYPE
The type of file being printed: "job-sheet" for a banner page and
"document" for a regular print file.
CUPS_SERVERROOT
Le répertoire racine du serveur.
DEVICE_URI
L'uri du périphérique associé à l'imprimante.
FINAL_CONTENT_TYPE
Le type MIME associé à l'imprimante (par exemple
application/vnd.cups-postscript).
LANG
La locale de la langue par défaut (généralement C ou en).
PATH
Le chemin d'exécution par défaut pour les programmes externes qui
peuvent être exécutés par le filtre.
PPD
Le chemin complet vers le fichier PPD (PostScript Printer
Description) de cette imprimante.
PRINTER
Le nom de l'imprimante.
RIP_CACHE
La quantité de mémoire recommandée pour les RIP (Raster Image
Processors).
SOFTWARE
Le nom et la version du serveur (par exemple CUPS/1.2).
TZ
Le fuseau horaire du serveur
USER
L'utilisateur qui exécute le filtre, typiquement lp ou root ;
consultez le fichier cupsd.conf(5) pour le paramétrage courant.
COMPATIBILITE
Alors que l'interface des filtres est compatible avec l'interface des
scripts Système V, elle ne fonctionnera avec le script d'interface
Système V que comme unique filtre. Typiquement le script d'interface
sera fournit par la commande lpadmin(8) en utilisant l'option -i.
VOIR AUSSI
backend(7), cupsd(8),
http://localhost:631/help
COPYRIGHT
Copyright 2007-2009 by Apple Inc.