dimanche 15 août 2004

Documentation

This Web page is merely planned, and the bulk of information I have accumulated for this topic is kept elsewhere, in another format.

Man pages, --help and Info


In the old times and traditionally, Unix uses so called man pages for documenting programs, system calls, libraries, file formats and many such technical matters. The GNU project, which indented to provide a free Unix clone, chose Info files instead. While many people understood the virtues of Info, others were rather irritated by it, and I've seen many arguments from both camps over the years. Some confusion also existed as for many packages, documentation existed in both formats, sometimes written by different people, with synchronisation problems at update or correction time.

I'm merely throwing a few ideas here, quickly, and am not trying to write an essay about all this. My own opinion is that we can produce better documentation aiming the Info paradigm that we could using man pages. If I'm telling my bias right now, this is so people having religious feelings on this issue could stop reading right away, and so protect their faith! ☺

Despite many man pages are extensive, the overall goal of man pages is to present a synoptic synthesis of what needs to be known about a particular topic. Many man pages are concise and even terse.

Conversions reST à Tomboy


 Je pense me limiter à reStructuredText pour les documents qui doivent être publiés par ailleurs (dans des distributions de logiciels par exemple) et qui doivent contenir des éléments plus complexes (comme des tableaux).

Voici une liste des fichiers reStructuredText que j'aimerais peut-être convertir en notes Tomboy, si je trouvais une solution à quelques problèmes techniques qui y sont associés:

  • ~/musique/orgue/Épiphanie/web/src/index.rst
  • ~/fp/web/plaisirs/monocycle/src/gilles.rst
  • ~/fp/web/plaisirs/monocycle/src/index.rst
  • ~/dessins/web/src/recode-anim.rst
  • ~/erlang/web/src/erlang_reminder.rst
  • ~/fp/BarCamp/slides.rst
  • ~/musique/web/src/partitions.rst
  • ~/fp/web/plaisirs/l-épiph/src/index.rst
  • ~/dessins/web/src/NRart.rst
  • ~/fp/web/projets/src/traiter.rst