Manuel d’utilisation

Man pages, et manuel d’utilisation.

Tout bon système d’exploitation qui se respecte se doit de fournir à minima un manuel d’utilisation afin d’utiliser les outils fourni, et c’est précisément le cas avec les systèmes Gnu/Linux.

Historiquement les systèmes Gnu/linux n’avait pas forcément un bureau comme nous les connaissons maintenant, vous aurez donc le man-page d’une part, plus orienté sur les manipulations en ligne de commande, et d’autres part les manuels construit depuis en fonction de votre environnement.

Ce manuel a été publié en 1971 par Dennis Ritchie (également inventeur du langage C) et Ken Delotta à la demande de Doug McIlroy, (source wikipédia), toutefois j’ai trouvé autre chose dans le man du man.

  • HISTORIQUE
    1990, 1991 – Première version écrite par John W. Eaton (jwe@che.utexas.edu).23 Décembre 1992 : Rik Faith (faith@cs.unc.edu) a appliqué les correctifs fournis par Willem Kasdorp (wkasdo@nikhefk.nikef.nl).30  avril 1994 – 23 février 2000 : Wilf. (G.Wilford@ee.surrey.ac.uk) adéveloppé et assuré la maintenance de ce programme avec l’aide de quelques personnes moti‐
    vées.30 octobre 1996 – 30 mars 2001 : Fabrizio Polacco <fpolacco@debian.org> a assuré la maintenance et développé ce programme pour le projet Debian avec  l’aide  de
    toute la communauté.

    Depuis le 31 mars 2001 : Colin Watson <cjwatson@debian.org> est désormais le responsable et le développeur de man-db.

Les pages de manuel sont édité dans un format, roff, groff ou  troff, qui permet d’exporter les documents vers d’autres formats comme html ou postscript , tout en conservant la mise en page.

Elles sont stockées sous forme d’archive à l’intérieur du système la plupart du temps:

  •  /usr/share/doc/<application>/
  • /usr/share/doc/<application>/html/index.html

Les fichiers au format .html ne sont pas forcément présent dans votre système.

Vous trouverez également un format comme docbook, plus récent qui fonctionne un peu comme le html et le css, on sépare le fond et la forme, le contenu et le contenant, et exporte vers de nombreux format.

docbook est un schéma permettant une mise en page standardisée pour les notices techniques, ce que vous retrouvez en mode graphique, l’édition sous ce format reste complexe et précis.

En ligne de commande: CLI

Si vous souhaitez obtenir des informations sur la commande ls (lister), il suffit d’utiliser la commande man :

  • man ls

capture d'écran1

Le man propose une aide en 8 sections présentées comme ceci:

  • NAME
    • Représente le nom de la commande demandée
  • SYNOPSIS
    • Donne un exemple d’utilisation de la commande
  • DESCRIPTION
    • Fourni l’ensemble des options disponible et leur description
  • AUTHOR
    • Le nom des auteurs du programme pour ls c’est Richard M Stallman et David MacKenzie
  • BUGS
    • Indique comment remonter un bug
  • COPYRIGHT
    • Indique les droits d’auteurs et la licence utilisé
  • SEE ALSO
    • Fourni des informations additionnel et vous renvoi vers d’autres programme

Plus d’info dans le prochain article « man-page »

En environnement graphique

KDE

Directement depuis le menu, sobrement appelé aide, vous avez accès .

man1Depuis une application dans la rubrique aide, et mieux encore avec le raccourci F1, comme indiqué.

man3Voici à quoi il ressemble sous KDE c’est le menu aide générale de KDE, Dolphin se trouvera logiquement dans Manuels des applications.

man4

Gnome314

Même icône une petite bouée.

man5Et il est plutôt soigné.

man6Directement depuis une application avec F1.

man7LXDE

Là un peu moins d’aide, pas de menu d’aide c’est dommage.

Quelques applications disposent d’une aide, par exemple pour Geany, l’éditeur de texte, l’aide ouvre directement le navigateur internet, et on voit donc le chemin.

Attention; il n’y pas forcément un index.html pour toutes les applications, dans l’arborescence.

LXDE est l’environnement par défaut de Crunch#++.

man11Sous débian ce sera pareils, très peu d’aide de disponible pour les applications, voir en ligne .

man12Et l’aide info…je ne crois pas que se soit avec ça que l’on va attirer les biginners, en fait c’est inexploitable pour un débutant.

man13Voilà nous allons passer au man-pages, en ligne de commande et en profiter pour faire 2 ou 3 exercices.

Comments

So empty here ... leave a comment!

Laisser un commentaire

Sidebar