NOM
edix_man - Description des pages de manuel disponibles sous edix
INTRODUCTION
Pour l'essentiel, la documentation d'edix(7f) s'appuie sur la commande unix man(1). On parle des pages de manuels. Dans un terminal (voir edix_terminal(7f)), si vous souhaitez accéder à la documentation associée à un mot clé, par exemple accéder aux documentations associées au mot clé <printf> et au mot clé <edix>, vous saisissez la commande man suivie du mot clé, donc dans nos deux exemples :
- etudiant:~ $ man printf
et
- etudiant:~ $ man edix
LES SECTIONS
Avec les deux exemples qui précèdent, vous constaterez que les pages de manuel peuvent avoir des objectifs très divers :
-
- *
- la première documente l'utilisation de la commande shell printf, dans une logique d'exustivité (toutes les utilisations possibles de printf sont documentées ;
- *
- la seconde propose description rapide d'edix, envisagée comme une aide à la découverte, sans aucune systématique.
| 1 | commandes utilisateur | 1p | commandes utilisateur (POSIX) | |||
| 2 | appels système |
|
| |||
| 3 | fonctions de bibliothèque | 3p | fonctions de bibliothèque (POSIX) | |||
| 4 | fichiers spéciaux |
|
| |||
| 5 | formats de fichier |
|
| |||
| 6 | jeux |
|
| |||
| 7 | divers |
|
| |||
| 8 | administration système |
|
| |||
| 9 | interface du noyau Linux |
|
|
Un même mot clé peut notamment être documenté dans plusieurs section. Le mot clé <printf> est présent à la fois dans la section 1 (pour la description de la commande) et dans la section 3 (pour la description des bibliothèques correspondantes). Lorsque vous faites appel à man sans préciser la section, c'est ici la section 1 qui est retenue, mais vous pouvez consulter la page de printf de la section 3 avec
- etudiant:~ $ man 3 printf
Ce même mot clé <printf> est aussi présent dans une autre section, qui ne fait pas partie des sections principales d'unix : la section 1p. Cette section correspond à la norme posix (voir unix_shell(7f)). Donc si vous consultez la page de manuel de printf avec
- etudiant:~ $ man 1p printf
vous obtiendrez une documentation qui sera restreinte aux seules fonctionnalités de la commande printf qui sont en accord avec la norme posix.
LA SECTION DES PREMIERES PAGES DE MANUEL D'EDIX
Les premières pages de manuel d'edix sont toutes dans la section 7 (divers) car elles n'ont pas d'autre objectif que d'accompagner votre pratique, notamment à partir d'exemples qui couvrent plusieurs sections simultanément.
Le chiffre 7 est suivi de la lettre f que nous utilisons pour spécifier l'appartenance à la documentation d'edix. Une conséquence de ces deux choix est que vous pouvez afficher la liste des premières pages de manuel d'edix en saisissant seulement le début de la commande
- etudiant:~ $ man 7f
et en finissant par la touche <TAB>, deux fois. Vous obtiendrez typiquement
- edevstar edix_son edix edix_ssh edix_apres_installation edix_terminal edix_chroot edix_tmate edix_cle_usb edix_travail_a_distance edix_co_ecriture edix_travaux_pratiques edix_developpeurs edix_unix edix_developpeurs_mise_a_jour edix_utilisateurs edix_drawpile edix_utilisation edix_environnement_etudiant edix_vim edix_fenetres edix_wifi edix_fille edstar edix_gentoo_binaire edstar_demonstrateur edix_gestes_de_base edstar_demonstrateur_1 edix_git edstar_demonstrateur_2 edix_installation edstar_immersion edix_machine_dediee edstar_monte-carlo edix_machine_virtuelle edstar_permanence edix_man edstar_travail_a_distance edix_mise_a_jour sans_edix edix_mumble sans_edix_android edix_premiers_pas sans_edix_android_termux edix_problemes_boot sans_edix_unix edix_problemes_startx sans_edix_windows edix_shell sans_edix_windows_msys2
VOIR AUSSI
edix(7f), edix_terminal(7f), printf(1), printf(3), printf(1p), unix_shell(7f)
