NOM¶

filter - Interface pour des filtres de conversion de fichiers pour CUPS.

SYNOPSIS¶

filter travail utilisateur titre copies options[ nom-fichier ]

DESCRIPTION¶

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 soit envoyé à un autre filtre afin d'être imprimable. Les filtres doivent être capables de lire depuis un nom de fichier fourni 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. Le nom de la commande ( argv[0]) vaut le nom de l'imprimante de destination, mais est également disponible dans la variable d'environnement PRINTER.

AVERTISSEMENT¶

Les filtres CUPS ne sont pas faits pour être lancés directement par l'utilisateur. À côté des problèmes liés à l'ancienne interface System V ( argv[0] est le nom de l'imprimante), les filtres de CUPS attendent également des variables d'environnement et descripteurs de fichiers spécifiques, et sont généralement lancés dans une session utilisateur qui (sous OS X) possèdent des restrictions supplémentaires qui affectent la façon dont ils fonctionnent. À moins que vous ne soyez un développeur ou que vous sachiez ce que vous faites, veuillez ne pas lancer les filtres directement. À la place veuillez utiliser le programme cupsfilter(8) pour utiliser les filtres adéquats pour effectuer la conversion dont vous avez besoin.

OPTIONS¶

Les options passées sur la ligne de commande n'incluent généralement pas le fichier PPD par défaut de l'imprimante. De plus, certaines options doivent être indiquées de plusieurs façons différentes — « landscape » est synonyme de « orientation-requested=4 », « media » est synonyme de « PageSize » « PageRegion » « InputSlot » et « MediaType », et « sides » est synonyme des nombreuses options de « Duplex ». Les filtres non vectoriels doivent accepter à la fois la spécification explicite et la spécification implicite des options PPD — utilisez les fonctions ppdMarkDefaults et cupsMarkOptions de la bibliothèque de CUPS pour employer la bonne correspondance, et ppdFindMarkedChoice pour obtenir le choix fait par l'utilisateur. Les filtres vectoriels devraient utiliser les choix optionnels passés par les entêtes de la page vectorielle, étant donné qu'ils sont à l'identique des options activées pour une page donnée. Les options passées sur la ligne de commande déterminent les valeurs par défaut pour le travail en entier, et peuvent être outrepassées en les définissant par page.

MESSAGES JOURNALISÉS¶

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 le nom de la tâche ou la(es) propriété(s) de l'imprimante. Les propriétés de travaux suivantes peuvent être paramétrées : « job-media-progress ». Les propriétés d'imprimantes suivantes peuvent être paramétrées : « auth-info-required », « marker-colors », « marker-high-levels », « marker-levels », « marker-low-levels », « marker-message », « marker-names », « marker-types », « printer-alert » et « printer-alert-description ».

CRIT: message

 

Définir l'attribut printer-state-message et ajouter le message donné au journal ErrorLog actuel en utilisant le niveau de journalisation « critical ».

DEBUG: message

 

Définir l'attribut printer-state-message et ajouter le message donné au journal ErrorLog actuel en utilisant le niveau de journalisation « debug ».

DEBUG2: message

 

Définir l'attribut printer-state-message et ajouter le message donné au journal ErrorLog actuel en utilisant le niveau de journalisation « debug2 ».

EMERG: message

 

Définir l'attribut printer-state-message et ajouter le message donné au journal ErrorLog actuel en utilisant le niveau de journalisation « emergency ».

ERROR: message

 

Définir l'attribut printer-state-message et ajouter le message donné 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 donné 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 forme définit l'attribut job-media-sheets-completed au nombre de pages.

PPD: Mot Clé=Valeur ... Mot CléN=Valeur

 

Définir les mots clés dans le fichier PPD de l'imprimante. Ceci est généralement utilisé pour mettre à jour les options de mots clés par défaut telles que DefaultPageSize et les nombreuses options insérables dans le fichier PPD.

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 des mots clé raison-état-imprimante de la file d'attente en cours. C'est utilisé généralement pour indiquer l'état du média, de l'encre et de l'encre en poudre (toner) d'une imprimante.

WARNING: message

 

Définir l'attribut printer-state-message et ajouter le message donné 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, généralement 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

 

Le répertoire où se trouvent les fichiers cache semi-persistant.

CUPS_DATADIR

 

Le répertoire où se trouvent les fichiers de données.

CUPS_FILETYPE

 

Le type du fichier en cours d'impression : « job-sheet » pour une bannière et « document » pour une impression de fichier normale.

CUPS_MAX_MESSAGE

 

La taille maximale d'un message envoyé à la sortie d'erreur, incluant n'importe quel préfixe et le caractère de nouvelle ligne.

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, généralement « lp » ou « root » ; consultez le fichier cupsd.conf(5) pour le paramétrage actuel.

COMPATIBILITɶ

Alors que l'interface des filtres est compatible avec les scripts d'interface Système V, elle ne fonctionnera avec le script d'interface Système V que comme filtre unique. Normalement, le script d'interface sera fourni par la commande lpadmin(8) en utilisant l'option -i.

VOIR AUSSI¶

backend(7), cupsd(8), cupsfilter(8), <URL: http://localhost:631/help>

COPYRIGHT¶

Copyright 2007-2013 par Apple Inc.