Linux Certif

Toute la documentation sur la certification Linux LPI

reportbug

NOM

reportbug - Signaler un bogue auprès du serveur de bogues

SYNOPSIS

reportbug [options] <paquet | pseudo-paquet | chemin-absolu>

DESCRIPTION

reportbug a été initialement conçu pour signaler les bogues de la distribution Debian ; son comportement par défaut est d'envoyer un courriel au système de suivi des bogues Debian (Debian Bug Tracking System) à submit@bugs.debian.org comportant les informations sur le bogue que vous avez découvert. Une copie vous est aussi envoyée. Généralement, vous devez rédiger votre rapport en anglais(NdT).

Grâce à l'option --bts, vous pouvez aussi envoyer le rapport de bogue à d'autres serveurs qui utilisent debbugs, le système de suivi des bogues Debian (Debian Bug Tracking System).

Vous pouvez indiquer soit un nom de paquet, soit un fichier (avec son chemin absolu) ; si vous indiquez un nom de fichier, il doit commencer par un / pour être compris. Si vous voulez que reportbug recherche un fichier dans votre machine, consultez l'option --file ci-dessous.

Vous pouvez aussi indiquer un pseudo-paquet. Dans le système de suivi de bogues de Debian, les pseudo-paquets servent à suivre les erreurs qui ne sont pas liées à un paquet précis. Lancez reportbug sans aucun paramètre, puis répondez other (« autre ») à la question du paquet, vous verrez alors la liste des pseudo-paquets les plus couramment utilisés.

OPTIONS

Ce programme utilise la syntaxe habituelle des commandes GNU, dans laquelle les options longues (sous forme de mots) sont précédées de deux tirets («-- »). Un résumé des options est fourni ci-dessous.

-h, --help

Afficher un résumé des options.

--version

Afficher la version de reportbug et s'arrêter.

-a, --af

Utiliser le lecteur de courriel af pour l'édition et l'envoi du rapport de bogue, plutôt que de lancer un éditeur.

-A NOM_DE_FICHIER, --attach=NOM_DE_FICHIER

Joindre un fichier au rapport de bogue. Les fichiers textes et les fichiers binaires sont tout deux acceptés. Cette routine va créer une pièce jointe au format MIME qui contiendra le fichier. Dans certains cas (notamment les fichiers textes), il est préférable d'utiliser l'option --include. (Notez bien que le système de suivi des bogues Debian ne supporte les attachements MIME que d'une façon limitée).

-b, --no-query-bts

Ne pas vérifier auprès du système de suivi de bogues Debian si ce problème a déjà été signalé. Cela est pratique lorsque vous n'êtes pas connecté ou si vous êtes vraiment sûr que c'est un bogue.

--query-bts

Vérifier si ce problème a déjà été signalé au système de suivi des bogues Debian (comportement par défaut).

-B SYSTÈME, --bts=SYSTÈME

Utiliser le serveur de bogues indiqué par SYSTÈME plutôt que celui de Debian (ou le serveur de bogues indiqué dans /etc/reportbug.conf). Vous pouvez vous servir de help afin d'obtenir la liste de serveurs supportés.

--body=CORPS

Utiliser le CORPS spécifié comme corps du message. Le corps du texte sera ajusté à 70 colonnes, et les entêtes et pieds de page standards de reportbug seront ajoutés de façon appropriée. Les questions concernant l'éditeur et les autres questions « spéciales » ne seront pas posées. Généralement, vous devez rédiger votre rapport en anglais(NdT).

--body-file=FICHIER-MESSAGE

Le contenu du fichier (supposé) texte FICHIER-MESSAGE servira de corps de message. Ce fichier doit être bien formé (par exemple, longueur des lignes raisonnable, etc.). Les entêtes et pieds de page habituels seront ajoutés. Les questions concernant l'éditeur et toute autre question «spéciale » ne seront pas posées. (FICHIER-MESSAGE peut aussi être un tube nommé (« named pipe ») ; l'utilisation d'un fichier spécial de périphérique peut conduire à des résultats étonnants). Généralement, vous devez rédiger votre rapport en anglais(NdT).

-c, --no-config-files

Ne pas joindre les fichiers de configuration au rapport de bogue, sans demander confirmation. Le comportement habituel est de vous demander si vous voulez les inclure ; dans certains cas, cela pourrait envoyer des informations sensibles via courriel.

--configure

Relancer la procédure de configuration de la première exécution de reportbug, et créer un nouveau fichier .reportbugrc. Tous les réglages déjà définis dans ce fichier seront effacés ; cependant, une sauvegarde sera enregistrée dans .reportbugrc~.

--check-available

Vérifier les nouvelles versions du paquet sur packages.debian.org (par défaut). Dans les modes advanced et expert, vérifier aussi sur incoming.debian.org et http://ftp-master.debian.org/new.html.

--no-check-available

Pas de vérification de la présence de nouvelles versions du paquet sur packages.debian.org.

-d, --debug

Ne pas réellement envoyer le rapport de bogue à Debian ; l'envoyer seulement à vous. Sert en premier lieu à des fins de test pour le responsable du paquet.

-e ÉDITEUR, --editor=ÉDITEUR

Définir l'éditeur de texte à utiliser, en outrepassant toutes les variables d'environnement telles que VISUAL ou EDITOR.

--email=ADRESSE

Définir l'adresse de courriel de l'expéditeur du rapport de bogue (l'adresse qui apparaît dans le champ From:). Cette adresse doit correspondre à votre adresse de courriel Internet en tant que telle (sans votre nom complet ou tout autre commentaire). Ce réglage outrepasse les variables d'environnement EMAIL et DEBEMAIL, mais pas REPORTBUGEMAIL.

--exit-prompt

Afficher un message avant de quitter. Pratique quand reportbug n'est pas lancé par un vrai terminal (« transient terminal ») (à partir du menu Debian, par exemple).

-f NOM-FICHIER, --filename=NOM-FICHIER

Créer un rapport de bogue pour le paquet contenant NOM-FICHIER afin d'éviter de chercher le paquet auquel ce fichier appartient. La recherche est d'abord effectuée en utilisant NOM-FICHIER comme un chemin complet, puis elle est étendue à tous les fichiers du chemin.

--path

Si l'option -f est spécifiée conjointement, ne rechercher le fichier NOM-FICHIER que dans le chemin donné. Préciser un chemin absolu (commençant par un /) avec l'option -f outrepassera cette option.

-g, --gnupg, --gpg

Joindre une signature numérique au rapport de bogue de type GnuPG (GNU Privacy Guard). Cet argument sera ignoré si vous utilisez un client de messagerie (un « MUA ») pour éditer et envoyer votre rapport de bogue.

-G, --gnus

Utiliser le lecteur de courriels et de nouvelles GNUS plutôt que l'éditeur pour l'envoi de votre rapport de bogue.

-H ENTÊTE, --header=ENTÊTE

Ajouter un en-tête RFC 2822 personnalisé à votre courriel ; pour envoyer une copie conforme de votre rapport de bogue à debian-68k@lists.linux-m68k.org par exemple, vous pouvez indiquer -H 'X-Debbugs-CC: debian-68k@lists.linux-m68k.org'.

-i FICHIER, --include=FICHIER

Include the specified file as part of the body of the message to be edited. Can be used multiple times to add multiple files; text-only please! From a suggestion by Michael Alan Dorman in the bug mailing list. (See also the --attach option.)

-I, --no-check-installed

Ne pas vérifier si le paquet est installé avant de remplir le rapport. Pratique en général pour remplir un rapport sur un paquet dont vous savez qu'il n'est pas installé sur votre système.

--check-installed

Vérifier si le paquet indiqué est installé lors de la création du rapport de bogue. (Comportement par défaut).

-j JUSTIFICATION, --justification=JUSTIFICATION

Dans Debian, les bogues de niveau « serious », « grave », ou «critical » doivent remplir certains critères afin de justifier d'une telle appellation. Cette option vous permet de préciser la justification du niveau critique du bogue, plutôt que d'attendre qu'on vous pose la question.

-k, --kudos

Envoyer un courriel de remerciement à l'adresse du responsable enregistré plutôt que de créer un rapport de bogue. Vous pouvez aussi envoyer des remerciements à nom-du-paquet@packages.debian.org, pour les paquets de l'archive officielle Debian ; dans tous les cas, cette option utilise l'adresse du responsable indiquée dans le fichier de contrôle du paquet. Cela garantit son bon fonctionnement pour des paquets d'autres origines.

-K CLÉ-PRIVÉE, --keyid=CLÉ-PRIVÉE

Clé privée à utiliser pour les signatures PGP/GnuPG. Sans cette précision, c'est la première clé de votre trousseau secret correspondant à votre adresse de courriel qui sera utilisée.

--license

Afficher le copyright de reportbug et les informations de licence sur la sortie standard.

--list-cc=ADRESSE

Envoyer une copie conforme du rapport à la liste indiquée dès qu'un numéro de rapport de bogue a été assigné. Équivalent à l'option -H 'X-Debbugs-CC: ADDRESS'. Cette option ne fonctionnera comme prévu qu'avec des systèmes de type debbugs.

-m, --maintonly

N'envoyer le rapport de bogue qu'au responsable du paquet ; le système de suivi des bogues n'enverra pas de copie à la liste de distribution du rapport de bogue.

--mode=MODE

Définir le mode de fonctionnement de reportbug. reportbug a actuellement quatre modes de fonctionnement : novice (par défaut), standard, advanced, et expert.

Le mode novice est conçu pour réduire le nombre de questions portant sur des points que les « utilisateurs normaux » ne connaissent pas trop, ou dont ils se moquent, reportant le travail d'approfondissement sur les épaules du responsable. Dans ce mode, la vérification de l'existence de versions plus récentes n'est effectuée que pour la distribution stable. C'est actuellement le mode par défaut.

Le mode standard correspond approximativement aux questions posées par les versions de reportbug 1.50 et précédentes ; cela englobe un nombre de questions relativement important, et ce afin de pousser les utilisateurs à ne pas faire de rapport de bogue en double ou farfelus.

Le mode advanced ressemble au mode standard, mais peut offrir des raccourcis pratiques pour les utilisateurs avancés de Debian, sans être toutefois d'aussi bas niveau (et donc potentiellement source de contreverses, « prises de bec ») que le mode expert. (Les seules différences avec le mode standard sont la connaissance supposée de la part de l'utilisateur de la file d'attente « incoming », la possibilité de recenser un bogue sur des paquets en « dépendance », et l'absence d'aide pour l'insertion du texte du rapport de bogue dans l'éditeur)

Le mode expert est conçu pour réduire le nombre de questions qui servent à limiter les rapports de bogues farfelus ou inutiles, les « exagérations de la gravité » et le reste. Dans le mode expert, reportbug considère que l'utilisateur est plus que familier avec les règles Debian. Ce qui signifie dans la pratique que le rapporteur n'a pas à se justifier lors d'un choix de sévérité élevée pour son rapport de bogue, et que certains automatismes de nettoyage du message sont inactifs. L'utilisation du mode expert est fortement déconseillée aux personnes qui ne participent pas régulièrement au projet Debian, car cela pourrait leur valoir une prise de bec avec les responsables des paquets en cas de mauvaise utilisation.

-M, --mutt

Utiliser le lecteur de courriel mutt pour l'édition et l'envoi du rapport de bogue plutôt que d'invoquer un éditeur.

--mta='<MTA>'

Spécifier un autre serveur de messagerie (« MTA »), à la place de /usr/sbin/sendmail (par défaut). Toute définition de smtphost outrepassera celui-ci.

--mua='<MUA> <option>'

Utiliser le client de messagerie (« MUA », Mail User Agent) indiqué pour l'édition et l'envoi du rapport de bogue plutôt que d'invoquer un éditeur. Le paramètre option doit être utilisé pour préciser à votre lecteur de courriel qu'il doit interpréter le rapport de bogues en tant de message brouillon. Pour en savoir plus sur cette façon de fonctionner, regardez comment les options --mutt, --nmh et --af sont traitées.

-n, --nmh, --mh

Utiliser la commande comp (qui fait partie des systèmes de courrier nmh et mh) pour l'édition et l'envoi du rapport de bogues plutôt que d'invoquer un éditeur.

-o FICHIER, --output=FICHIER

Rediriger le courriel vers le fichier indiqué plutôt que de l'envoyer.

-O, --offline

Désactiver toutes les requêtes vers l'extérieur. A actuellement le même effet que --no-check-available --no-query-bts.

-p, --print

Écrire le rapport de bogue sur la sortie standard plutôt que de l'envoyer par courriel, afin de pouvoir le rediriger dans un fichier ou le passer par un tube (pipe) à un autre programme.

Cette option ne fournit qu'un modèle (template) pour le rapport de bogue. Vous devrez remplir la description détaillée.

--paranoid

Afficher le contenu du message avant son envoi, avec toutes ses entêtes. Cette option est automatiquement désactivée dans le mode template (modèle).

--no-paranoid

Ne pas afficher le contenu complet du message avant de l'envoyer (mode par défaut).

--pgp

Joindre au rapport de bogue une signature numérique en utilisant PGP (Pretty Good Privacy). Notez bien, cependant, que le projet Debian abandonne l'emploi de PGP au profit de GnuPG. (Ce paramètre sera ignoré si vous utilisez un client de messagerie pour l'édition et l'envoi de votre rapport).

--proxy=SERVEUR-MANDATAIRE, --http_proxy=SERVEUR-MANDATAIRE

Indiquer le serveur mandataire (« proxy ») à utiliser pour la gestion de la requête au système de suivi des bogues. Ce paramètre n'est utile que derrière un pare-feu (« firewall »). L'argument SERVEUR-MANDATAIRE doit être au format valide d'une URL HTTP, et comporter (si nécessaire) un numéro de port ; http://192.168.1.1:3128/ par exemple.

-P PSEUDO-ENTÊTE, --pseudo-header=PSEUDO--ENTÊTE

Ajouter une pseudo entête à votre courriel. Si vous voulez, par exemple, ajouter au bogue le usertag mytag concernant l'utilsateur humberto@example.com, vous pouvez utiliser -P 'User: humberto@example.com' -P 'Usertags: mytag'

-q, --quiet

Ne plus envoyer les messages de type diagnostic sur la sortie d'erreurs (standard error).

-Q, --query-only

Interroger simplement le BTS, sans soumettre de rapport de bogue. Cette option est ignorée si vous demandez --no-bts-query.

--query-source

Faire porter l'interrogation sur tous les paquets binaires construits à partir de la même source, et pas seulement sur le paquet binaire indiqué (comportement par défaut depuis reportbug 2.0)

--no-query-source

La requête ne portera que sur le paquet binaire indiqué sur la ligne de commande.

--realname=NOM

Définir le nom réel (un nom lisible par les gens) à utiliser pour votre rapport.

--report-quiet

Enregistrer le bogue dans le système de suivi des bogues sans envoyer de rapport au responsable du paquet ni à qui que ce soit. À ne pas utiliser sauf si vous êtes le responsable du paquet en question, ou si vous savez vraiment ce que vous faites.

--reply-to=ADRESSE, --replyto=ADRESSE

Définir l'adresse du champ Reply-To de l'entête de votre rapport.

-s OBJET, --subject=OBJET

Définir l'objet du rapport de bogue (une rapide présentation du problème, de moins de 60 caractères). Si vous ne spécifiez pas ce paramètre, l'objet du message vous sera demandé.

-S GRAVITÉ, --severity=GRAVITÉ

Définir le niveau de gravité, choisi parmi critical, grave, serious, important, normal, minor, et wishlist (critique, grave, sérieux, important, normal, mineur, et souhait).

--smtphost=HÔTE[:PORT]

Utiliser le serveur de messagerie (MTA) de la machine HOST afin d'envoyer votre rapport plutôt que votre programme /usr/sbin/sendmail local. En général, il s'agit du serveur de courrier sortant de votre fournisseur d'accès Internet ; vous pouvez aussi indiquer « localhost » si votre machine dispose d'un serveur de courriel en état de marche. Si vous ne précisez pas le PORT, c'est le port 25, port SMTP standard, qui sera utilisé.

--tls

En cas d'utilisation de SMTP, employer Transport Layer Security (TLS) pour sécuriser la connexion au serveur de courrier. Certains serveurs SMTP exigent parfois cette option.

--smtpuser=NOM_UTILISATEUR

En cas d'utilisation de SMTP, se servir du NOM_UTILISATEUR indiqué pour l'authentification.

--smtppasswd=MOT_DE_PASSE

En cas d'utilisation de SMTP, se servir du MOT_DE_PASSE indiqué pour l'authentification. Si le mot de passe n'est pas indiqué sur la ligne de commande ou dans le fichier de configuration, un message sera affiché pour le demander.

L'utilisation de cette option est dangereuse sur les systèmes multi-utilisateurs. Vous devriez plutôt définir ce réglage dans .reportbugrc, puis vous assurer que celui-ci n'est lisible que par votre utilisateur (grâce à chmod 600 $HOME/.reportbugrc, par exemple).

-t TYPE, --type=TYPE

Définir le type de rapport à soumettre ; accepte actuellement aussi bien gnats que debbugs.

-T BALISE, --tag=BALISE

Définir une balise à enregistrer dans le rapport, par exemple --tag=patch. Plusieurs balises peuvent être spécifiées en utilisant plusieurs paramètres -T ou --tag.

D'un autre côté, vous pouvez indiquer la balise none pour sauter l'étape des questions sur les balises, sans avoir à en fournir ; toutes les balises indiquées sur la ligne de commande seront elles aussi ignorées.

--template

Afficher un modèle (« template ») de rapport de bogue sur la sortie standard.

-v, --verify

Vérifier, grâce à debsums, l'intégrité du paquet (s'il est installé) avant de faire le rapport.

-V VERSION, --package-version=VERSION

Indiquer la version du paquet sur laquelle le problème a été rencontré. Ce sera probablement très utile si vous êtes en train de signaler un bogue sur un paquet non installable ou installé sur un autre système.

-x, --no-cc

Ne pas envoyer de copie cachée (BCC) du rapport de bogue à son auteur (c.-à-d. vous-même).

-z, --no-compress

Ne pas réduire la taille des fichiers de configuration par la suppression des commentaires et des lignes blanches.

EXEMPLES

reportbug lynx-ssl

Signaler un bogue sur le paquet lynx-ssl.

reportbug --path --file=ls

Signaler un bogue sur le paquet installé sur votre machine qui contient un programme nommé ls présent dans votre chemin de recherche.

FICHIERS DE CONFIGURATION

Depuis la version 0.22, reportbug utilise un contrôle de la syntaxe des fichiers en une seule passe. Les commandes sont lues dans /etc/reportbug.conf et $HOME/.reportbugrc, les dernières valeurs remplaçant les premières. Les commandes ne sont pas sensibles à la casse, et acceptent actuellement 0 ou 1 paramètre ; les paramètres qui contiennent des espaces doivent être protégés par des guillemets. Toute ligne commençant par un # est considérée comme un commentaire et sera donc ignorée.

En général, les options correspondant aux options longues (type GNU) de reportbug sont acceptées, sans les préfixer par la séquence --. Consultez le fichier reportbug.conf(5) pour connaître toutes les options acceptées.

VARIABLES D'ENVIRONNEMENT

VISUAL

Éditeur à utiliser pour l'édition du rapport de bogue.

EDITOR

Éditeur à utiliser pour l'édition du rapport de bogue (outrepassé par VISUAL).

REPORTBUGEMAIL, EMAIL, DEBEMAIL

Email address to use as your from address (in this order). If no environment variable exists, the default is taken from your user name and /etc/mailname.

DEBFULLNAME, DEBNAME, NAME

Nom complet à utiliser : il est tiré par défaut de /etc/passwd.

REPLYTO

Adresse à mettre dans le champ « Répondre à » (Reply-To) dans le courrier émis.

MAILCC

Adresse « Copie à » (CC) à utiliser dans votre courriel. Remarquez que vous pouvez aussi utiliser l'option -H dans ce but, ainsi que pour Copie Cachée (BCC).

MAILBCC

Adresse « Copie Cachée à » (BCC) à utiliser, plutôt que votre adresse de courriel. (« Copie à » et « Copie Cachée à » sont des options basées sur les suggestions de Herbert Thielen dans la liste de souhaits de bug).

http_proxy

Adresse du serveur mandataire (proxy) à utiliser afin de réaliser la requête au BTS. Doit être l'URL http valide d'un serveur mandataire, en précisant le numéro de port si nécessaire (n'indiquer qu'un nom de machine ou omettre le numéro de port s'il est différent de 80 NE FONCTIONNERA PAS).

NOTES

Le module getopt de Python est plus pointilleux sur l'ordre des paramètres de la ligne de commande que le getopt() du GNU ; tous les paramètres doivent être écrits avant le nom du paquet.

Il faudrait probablement que reportbug soit compatible avec d'autres systèmes de suivi des bogues, tels que bugzilla (utilisé par les projets GNOME et Mozilla) et jitterbug (utilisé par Samba, AbiSource et FreeCiv), mais il ne l'est pas.

VOIR AUSSI

reportbug.conf(5), http://www.debian.org/Bugs/Developer#tags à lire pour connaître les balises disponibles, querybts(1)

AUTEUR

Chris Lawrence <lawrencc@debian.org>.

TRADUCTION

Ce document est une traduction, réalisée par Sylvain Cherrier <sylvain.cherrier@free.fr> le 15 Nov 2004 et mise à jour en 2006.

L'équipe de traduction a fait le maximum pour réaliser une adaptation française de qualité.

La version anglaise la plus à jour de ce document est toujours consultable via la commande : man -L C reportbug

N'hésitez pas à signaler à l'auteur ou au traducteur, selon le cas, toute erreur dans cette page de manuel.