qRFCview : un petit logiciel libre sympa pour lire les RFC

Posté par  (site web personnel) . Modéré par Mouns.
Étiquettes :
1
20
juil.
2006
Internet
Ayant beaucoup à travailler avec des RFC de l'IETF, mon collègue Romain Rollet a programmé une petite application sympa pour les visualiser : qRFCview. C'est du libre sous licence GNU GPL. Programmé avec Qt 4 donc disponible pour Windows et Linux (et normalement MacOS X).

Fonctionnalités : création automatique d'une table des matières avec accès direct à une section donnée, gestion des références intra-RFC, téléchargement automatique d'une RFC dans un nouvel onglet par un clic sur sa référence ou son numéro, mise en cache des RFC récupérées, navigation par onglets et recherche.

Un paquet Debian a été également fait et recherche un mentor.

Aller plus loin

  • # Table des matières

    Posté par  . Évalué à 7.

    Je trouve que c'est une très bonne idée, par contre ça ne marche pas toujours. Par exemple ça marche avec la RFC de HTTP (#2616), mais pas avec la text/enriched MIME Content-type (#1896).
    Sinon c'est vraiment pratique :)

    Pour le deb, il faudrait rajouter une dépendance à qt4-dev-tools et un conflit avec qt3-dev-tools sinon ça build pas, et un petit lien de /usr/bin/qrfcview vers /usr/bin/qRFCView ;)

    • [^] # Re: Table des matières

      Posté par  . Évalué à 6.

      Et pour le cache des rfc, apparemment c'est dans le répertoire courant, ça serait pas mal de le faire dans ~/.qrfcview/cache ou autre, mais pas le répertoire courant. On sais jamais d'où on peut le lancer et ça peut mettre le basard un peu partout à force ;)

    • [^] # Re: Table des matières

      Posté par  (site web personnel) . Évalué à 3.

      par contre ça ne marche pas toujours. Par exemple ça marche avec la RFC de HTTP (#2616), mais pas avec la text/enriched MIME Content-type (#1896).


      Le format des RFC n'est pas entièrement figé et varie d'une RFC à l'autre. Les regexp utilisées pour identifier les éléments sont plutôt du genre « ça marche bien en général » que « le fonctionnement est garanti », et bien souvent améliorer un cas particulier dégrade un autre cas.

      Mais vous pouvez toujours renvoyer un rapport de bug avec des exemples précis (telle RFC à tel endroit) à l'auteur, on verra si on peut améliorer la chose.

      Amicalement,
      d.

      • [^] # Re: Table des matières

        Posté par  . Évalué à 10.

        Le format des RFC n'est pas entièrement figé

        Il faudrait faire une RFC pour normaliser tout ça

  • # Encouragements

    Posté par  . Évalué à 7.

    Alors là, voilà un logiciel qui aurait dû sortir depuis longtemps ! Ce qui est dommage, c'est que je ne l'ai pas eu sous la main quand j'ai lus des RFC pour DHCPv6, mais bon...
    Le soft prend un bon départ, avec la lecture automatique par numéro de RFC. Si jamais il pouvait gérer les drafts un jour (mais est-ce vraiment utile ?)
    Je pense que le développeur devrait prendre contact avec l'IETF, il y a des chances que ça les intéresse !

    Dernière chose : utiliser QT4 permet un binaire sous Windows, et c'est encore mieux :)

  • # Format des originaux ?

    Posté par  (site web personnel) . Évalué à -1.

    Le texte original des RFC est sous quelle forme ? Toujours en ASCII ?

    Si oui, pourquoi ne le mettent ils pas en XML ?

    Si non, n'est-il pas transformable en XML puis avec des feuiles de styles XSLT, on pourrait en faire du HTML.

    • [^] # Re: Format des originaux ?

      Posté par  . Évalué à 9.

      Oh, une solution à la recherche d'un problème à résoudre !

      C'est toujours amusant cette version informaticienne du proverbe passéiste "mettre la charue avant les boeufs".

      Meri à XML et à ses contempteurs ; -)

    • [^] # Re: Format des originaux ?

      Posté par  (site web personnel) . Évalué à 10.

      C'est pas par hasard que tous les RFC sont "Toujours en ASCII".
      Le but est de permettre sa lecture par tout le monde et le plus simplement possible.
      Qu'est-ce qu'il y a de plus simple à lire qu'un bête document texte ?
      De plus le format des RFC est normalisé pour justement assurer que tout le monde puisse y accéder.

      Je ne voit pas ce que XML / XSLT apporterait aux RFC. A mon humble avis, très mauvaise idée et perte de temps / productivité.
      Un parser de RFC, comme celui-ci, ça c'est une excellente idée.

      Bravo à son créateur, j'en aurai eu besoin il y a quelques temps encore mais bon, pour une prochaine fois peut-être :-)

      • [^] # Re: Format des originaux ?

        Posté par  (site web personnel) . Évalué à 1.

        Détrompez vous, je n'aime pas le XML et l'ai dis pleins de fois sur cette tribune.

        Mais il y en a qui aime et il faut avouer que ca peut être un format d'échange de données statique pratique.

        Pour en revenir au RFC, ils sont diffusés en version ASCII, effectivement lisible par tous mais je ne peux pas croire que ce soit l'original. Ce texte ASCII provient bien d'un formateur.

        Si les auteurs écrivent directement le texte en ASCII, chapeau. Cela ne me serais pas venu à l'idée d'écrire des choses si longue sous ce format là. Je serais passé par un formateur : LaTeX, Groff, TexInfo...

  • # Recherche d'une RFC

    Posté par  . Évalué à 1.

    Toujours en rapport avec les rfc, je me sers d'un truc pratique des navigateurs modernes : les mots clés internet. En gros je tape 'rfc 2616' dans la barre d'adresse de konqueror et il m'amene sur la rfc sur le site de l'ietf.

    Bon evidemment avec ce logiciel, c'est plus la peine :)

    • [^] # Re: Recherche d'une RFC

      Posté par  . Évalué à 1.

      Note qu'avec google ça doit deja pas etre loin, et puis un ou des deux bookmark plus une recherche, ce n'est pas bien compliqué..

      • [^] # Re: Recherche d'une RFC

        Posté par  . Évalué à -1.

        Justement, en faisant une recherche en tapant dans la barre d'addresse tu utilise sGoogle (recherche J'ai de la chance)

  • # gtk

    Posté par  . Évalué à -10.

    À quand une version utilisant gtk à la place de qt ?

    • [^] # Re: gtk

      Posté par  (site web personnel) . Évalué à 9.

      A quand une annonce de logiciel sans commentaire "ca serait vachement mieux avec [ici le nom d'un toolkit]" ?

      Plus sérieusement, je ne comprends toujours pas le problème d'installer QT et GTK sur la même machine ? Manque d'uniformisation graphique ? Mouais, y'a des choses plus graves dans la vie.

      Et note que je suis en ce moment un utilisateur de Gnome, mais ca m'empeche pas d'utiliser un paire d'applis Qt; faut bien se rendre compte qu'écrire toutes les applis graphiques en double pour satisfaire les gouts trollifères de chacun, c'est pas terriblement efficace.

      • [^] # Re: gtk

        Posté par  (site web personnel) . Évalué à 1.

        asv !

        Ha zut pardon c'est pas le bon thread. https://linuxfr.org/~Floxy/22238.html

        Sinon pour faire semblant de dire quelque chose d'utile, Vis c'est l'avenir (ou pas). http://modeemi.fi/~tuomov/vis/

        pertinent adj. Approprié : qui se rapporte exactement à ce dont il est question.

      • [^] # Re: gtk

        Posté par  . Évalué à -2.

        [root@localhost /var/tmp/distfiles 16:24]# emerge -vp qt
        These are the packages that would be merged, in order:

        Calculating dependencies... done!
        [ebuild N ] x11-libs/qt-4.1.4 USE="cups gif jpeg opengl png xinerama zlib -accessibility -debug -doc -examples -firebird -mng -mysql -nas -nis -odbc -postgres -sqlite" 31,420 kB

        Total size of downloads: 31,420 kB

        Télécharger 31Mo sur mon 56k pour UN logiciel qui m'a l'air assez léger, ça me fait quand même bien chier :)
        HS: Sinon, j'avais entendu dire qu'avec Qt 4 il y avait enfin une séparation entre Core (XML, réseau & co) et GUI. Pourquoi ce n'est pas séparé comme ça chez Gentoo ?

        • [^] # Re: gtk

          Posté par  (site web personnel) . Évalué à 1.

          Et en allant faire un petit tour sur ftp://ftp.gtk.org/pub/gtk/v2.10/ on remarque que GTK fait - au pifomètre gradué de précision - 20Mb (je compte Glib + Pango + Gtk bien entendu pour avoir l'équivalent à Qt). Waw, 11Mb de plus pour Qt. C'est vraiment une grosse merde ce Qt.

          Bon ok Qt c'est plus gros, mais c'est pas 30Mb vs 3Mb, c'est 30Mb vs 20Mb. Et puis y'a plus de choses dans Qt que dans Gtk, ca explique l'embonpoint (je pense a l'abstraction database).

          Tu as déjà passé 1h30 a télécharger GTK, donc 2h pour Qt ca me semble pas abusif. Et il faut bien avouer que les connections 56k se font de plus en plus rares ...

          • [^] # Re: gtk

            Posté par  . Évalué à 3.

            hé ho, ne sois pas tellement sur la défensive, je dis pas que Qt c'est de la merde hein, j'explique juste où est le problème d'installer GTK et QT. Oui, GTK et QT sont gros. Donc, dans la mesure du possible, j'aimerais n'en avoir qu'un... (et jusqu'ici, j'y suis arrivé sans trop de problème, et en bonus sans les libs gnome :))

  • # Abus des Acronymes !

    Posté par  . Évalué à -3.

    Je lis les dépeches de linuxfr depuis longtemps, et je crois etre vaguement familier au monde linux, mais cette avanlanche d'acronymes a de quoi decourager quelqu'un qui voudrais s'interesser au monde linux.

    La j'ai du regarder sur wikipedia pour comprendre que les RFC sont des documents standards concernant les normes internet, et l'IETF un groupe de travail sur les standards (corrigez moi si je me trompe :=)

    D'une maniere plus generale, je trouve qu'il y a beaucoup d'annonces sur linuxfr incompréhensible par le commun des mortels. J'ai l'impression parfois que le monde de linux s'isole de plus en plus en utilisant un vocabulaire hyper spécialise

    Je crois qu'il serait souhaitable, lorsque l'on poste une annonce un peu technique, de rappeler la signification des acronymes utilisés.

    • [^] # Re: Abus des Acronymes !

      Posté par  (site web personnel) . Évalué à 5.

      Pour le coup, les rfc n'ont rien à voir avec linux. Donc, avec un peu de chance, on peut s'en servir (à la fois de l'acronyme que les gens ne comprennent pas, et par la lecture obligatoire avant l'utilisation de quoi que ce soit de sa rfc) pour décourager le commun des mortels d'internet.

      linuxfr n'est probablement le site qui donne envie aux gens de passer à linux, s'ils viennent ici, c'est qu'ils ont déjà l'envie. Et je doute que ce soient les sigles qui feront fuir le quidam, plutôt l'esprit potache ou revêche, les blagues privées ou juste incompréhensibles.

      > Je crois qu'il serait souhaitable, lorsque l'on poste une annonce un peu technique, de rappeler la signification des acronymes utilisés.

      Par exemple en mettant des liens vers la page wikipedia sur les mots en question ? Oh, cela a été fait !

    • [^] # Re: Abus des Acronymes !

      Posté par  . Évalué à 4.

      En même temps, il y a des liens hypertext sur les acronymes RFC et IETF qui justement renvoie sur leur définition. Pas besoin de réecrire les articles de wikipédia, non plus! Et puis ici, RFC et IETF c'est un peu comme lol ou pdtr sur des djeuns sur un skyblog: tout le monde ou presque comprend, on ne fait plus attention ;)

    • [^] # Re: Abus des Acronymes !

      Posté par  (site web personnel) . Évalué à 5.

      Je lis les dépeches de linuxfr depuis longtemps
      ...
      La j'ai du regarder sur wikipedia pour comprendre que les RFC sont des documents standards concernant les normes internet

      Tu lis vraiment les dépêches de linuxfr depuis longtemps ?
      En plus y'a un hyperlien vers la définition wikipedia.
      Tu veux pas non plus le c^H^Hsourire de la crémière pendant que tu y es ?

    • [^] # Re: Abus des Acronymes !

      Posté par  . Évalué à 1.

      En l'occurrence, ce sont des sigles.

  • # Configuration d'un proxy

    Posté par  . Évalué à 1.

    Excellent !

    Voila un visionneur de RFC partique et facile d'utilisation !

    Je n'ai pas trouvé où configurer la connexion au réseau (ils nous "protègent" derrière un proxy au taf) mais c'est pas un problème puisqu'il suffit d'avoir les RFC en local pour pouvoir les lire.

    Trop bon boulot !

  • # Pour GNU Emacs

    Posté par  . Évalué à 2.

    Ca fait longtemps que ca existe mais peut-etre l'avez-vous manque :)

    Grace a :

    http://www.neilvandyke.org/rfcview/

    Ou meme juste avec ces quelques lignes:

    (defun rfc (num)
    "Show RFC NUM in a buffer."
    (interactive "nRFC (0 for index): ")
    (let ((url (if (zerop num)
    "http://www.ietf.org/iesg/1rfc_index.txt"
    (format "http://www.ietf.org/rfc/rfc%i.txt" num)))
    (buf (get-buffer-create "*RFC*")))
    (with-current-buffer buf
    (let ((inhibit-read-only t))
    (delete-region (point-min) (point-max))
    (let ((proc (start-process "wget" buf "wget" "-q" "-O" "-" url)))
    (set-process-sentinel proc 'rfc-sentinel))
    (message "Getting RFC %i..." num)))))

    (defun rfc-sentinel (proc event)
    "Sentinel for `rfc'."
    (with-current-buffer (process-buffer proc)
    (goto-char (point-min))
    (view-mode 1)
    (when (fboundp 'rfcview-mode)
    (rfcview-mode)))
    (display-buffer (process-buffer proc)))


    C'est beau Emacs :)

    • [^] # Re: Pour GNU Emacs

      Posté par  . Évalué à 2.

      Oui enfin ça fait pas tout à fait la même chose. D'après ce que j'ai compris ça ne fait que télécharger et afficher une rfc.
      Pour faire ça, il suffit d'un navigateur, Konqueror par exemple, ajouter un raccourci vers "http://www.ietf.org/rfc/rfc\{@}.txt" avec le mot clé rfc. ça fonctionne aussi avec Firefox avec un bookmark "http://www.ietf.org/rfc/rfc%s.txt".
      Ensuite "rfc 1" affiche la rfc 1.

      • [^] # Re: Pour GNU Emacs

        Posté par  . Évalué à -2.

        Je ne vois ce que ca change en fait. Je me demande si rfcview (que je n'utilise pas) ne fait pas exactement la m eme chose que qrfcview...

        Enfin de toute facon, il y a pas besoin d'un truc particulier pour lire ce genre de doc (j'utilise tout aussi bien w3m, more, less ...)

        • [^] # Re: Pour GNU Emacs

          Posté par  (site web personnel) . Évalué à 5.

          il y a pas besoin d'un truc particulier pour lire ce genre de doc


          Bien évidemment, il n'y a pas besoin de qRFCview pour lire du texte. Mais l'ajout d'une table des matières ou d'un renvoi à une section est très pratique quand on lit une RFC un tant soit peu compliquée, où les renvois sont très fréquents.

          Amicalement,
          d.

  • # Pour info

    Posté par  (site web personnel) . Évalué à 3.

    RFC Util [1] est un petit outil bien pratique et ultra simple pour effectuer des recherches et visualiser les RFC. Un complément fort utile pour qui s'intéresse au sujet.

    Un exemple valant mieux qu'un long discours:

    marge ~ # rfc -h
    rfc v3.2.3: perl util to search the rfc-index and disply the pages with $viewer
    usage: rfc # search rfc-index for specified RFC and list topic
    rfc -d # /path/ (optional) dumps plain text RFC. default is current dir
    rfc -h displays this stuff
    rfc -i updates the /var/cache/rfc/rfc-index via $viewer
    rfc -k keyword; same as -s
    rfc -l # spawns $viewer to the specified RFC
    rfc -m # user@remote.net [opt subject]; emails the RFC to given address
    rfc -n #/daemon local search for non-standard service/port nums
    (BO, Netbus, etc)
    rfc -o # Dumps RFC to STDOUT
    rfc -p Connect to INI's assigned numbers for proto nums or
    services/ports association
    rfc -r go wild with your own regexp on rfc-index
    rfc -s "string" Search the index for specific string
    rfc -u # sets the base URL to the number listed with -w
    rfc -w lists the available webservers to display
    baseURL=http://www.ietf.org/rfc/
    comments/bugfixes mailto: rfc@blinky-lights.org


    [1] http://www.dewn.com/rfc/

Suivre le flux des commentaires

Note : les commentaires appartiennent à celles et ceux qui les ont postés. Nous n’en sommes pas responsables.