Préparation LPI
Exam 101
Supplément 103.1. Partie
documentation
man, whatis, apropos
Document sous licence Creative commons « byncsa » http://creativecommons.org/licenses/byncsa/2.0/fr/
Sommaire
Utiliser et gérer la documentation interne
Documentation Linux sur Internet
Notifications utilisateurs à la connexion
UPMC – FP – Préparation LPI - v 1.1
2
103.1 Documentation interne
Commande man
Commande info
Commande whatis
Commande apropos
Documentation localisée dans le répertoire /usr/share/doc
Option -h | --help | -? de la commande
UPMC – FP – Préparation LPI - v 1.1
3
1.108.1 Documentation interne
man (manual)
Synopsis
man [options] [section] nom-objet
man [options] nom-fichier-man
But : visualiser des pages de manuel (manpages)
Fichier de conf : /etc/man.config
Utilisation d'outils de mise en page de pages textes (pager)
more (« one more page » )
less (« less is more » )
Sur les Linux récents, man est associé à la commande
less -is pour la visualisation des pages
Définition du pager par la variable PAGER du fichier
/etc/man.config
UPMC – FP – Préparation LPI - v 1.1
4
103.1 Documentation interne
quelques options ...
-w ou path : affiche la localisation des pages de manuel
plutôt que de les afficher
-f : équivalent à whatis
-k : équivalent à apropos
-d : mode debug
-a : affiche toutes les pages de manuel corrrespond à la
recherche s'il en exsite plusieurs
-P ou --pager : permet de définir un autre pager
UPMC – FP – Préparation LPI - v 1.1
5
103.1 Documentation interne
Les sections de pages de manuel
FHS ne définit que les sections de 1 à 8
Numéro de section
Nom
1
2
3
4
5
6
7
8
9
Commandes utilisateur (ls, rm, mkdir, ...)
Appels système ou fonction noyau (mount, sync, pipe)
Bibliothèques de fonctions
Pilotes et protocoles réseau (tty, null, random)
Publicité
Description des format | contenus de fichiers (fichiers
de conf)
Jeux
Divers
Commandes administrateur (iptables, mkfs, e2fsck)
Appel noyau Linux (vmalloc, vfree, proc_*)
UPMC – FP – Préparation LPI - v 1.1
6
103.1 Documentation interne
Certaines commandes | noms de fonction disposent de pages
dans plusieurs sections
[franck@localhost ~]$ man aw printf
/usr/share/man/man1/printf.1.gz
/usr/share/man/man1p/printf.1p.gz
/usr/share/man/fr/man3/printf.3.gz
/usr/share/man/man3/printf.3.gz
/usr/share/man/man3p/printf.3p.gz
Pour afficher toutes les pages de manuel existantes pour un
nom (à la fin de chaque page, man passe à la suivante) :
[franck@localhost ~]$ man a printf
Pour afficher la pages de manuel d'une section spécifique :
[franck@localhost ~]$ man 1 printf
UPMC – FP – Préparation LPI - v 1.1
7
103.1 Documentation interne
Format des pages de manuel (parties les plus courantes)
Entête
Name
Description
Nom suivi d'une courte description
Synopsis
Syntaxe de la commande
Description
Description de la commande
Options
les différents options possibles
Return values
pour ce qui est lié à la programmation
See also
Références complémentaires
Bugs
Files
....
Fichiers associés à l'objet (fichiers de conf d'une
commande par exemple)
Authors
les auteurs et traducteurs le cas échéant
UPMC – FP – Préparation LPI - v 1.1
8
103.1 Documentation interne
L'ordre de recherche dans les pages de manuel est définit
dans la variable d'environnement MANSECT
MANSECT est définie dans /etc/man.config
Default manual sections (and order) to search if S is not specified
and the MANSECT environment variable is not set (1x8x sections are used by
xorg packages).
#
MANSECT 1:1p:8:2:3:3p:4:5:6:7:9:0p:n:l:p:o:1x:2x:3x:4x:5x:6x:7x:8x
#
UPMC – FP – Préparation LPI - v 1.1
9
103.1 Documentation interne
Localisation des pages de manuel dans /usr/share/man.
La variable MANPATH contient la liste des répertoires dans
lesquels la commande man va rechercher les pages de
manuel
MANPATH est définie dans /etc/man.config
Publicité
Every automatically generated MANPATH includes these fields
#
MANPATH /usr/man
MANPATH /usr/share/man
MANPATH /usr/local/man
MANPATH /usr/local/share/man
MANPATH /usr/X11R6/man
UPMC – FP – Préparation LPI - v 1.1
10
103.1 Documentation interne
La commande manpath renvoie les chemins de recherche
des pages man
[franck@localhost ~]$ manpath
/usr/kerberos/man:/usr/local/share/man:/usr/share/man/fr:/usr/share/man:/usr/local/man
Imprimer les pages de manuel
l'option -t permet d'utiliser groff pour préparer la page pour
impression
[franck@localhost ~]$ man t info > info.ps
UPMC – FP – Préparation LPI - v 1.1
11
103.1 Documentation interne
Commande info
La FSF (Free software foundation) a fondé la documentation
des commandes GNU sous format Texinfo accessibles depuis
la commande info
Format Texinfo commun à l'affichage et à l'impression
Navigation à l'aide de liens hypertext comme avec un
navigateur (utilise les commandes emacs)
info info ou man info
UPMC – FP – Préparation LPI - v 1.1
12
103.1 Documentation interne
UPMC – FP – Préparation LPI - v 1.1
13
103.1 Documentation interne
Commande whatis
Recherche des motsclefs à l'intérieur d'une base de données
Elle est constituée des mots présents dans la section NAME
de la page de manuel
Base de données alimentée par la commande makewhatis
makewhatis est appelée régulièrement par l'intermédiaire de
script présent dans /etc/cron.daily et
/etc/cron.monthly
makewhatis -w utilise la commande manpath (ou man –
path) pour connaître les répertoires dans lequel il doit
rechercher les informations
Cette base se trouve dans le fichier
/var/cache/man/whatis
UPMC – FP – Préparation LPI - v 1.1
14
103.1 Documentation interne
man -f est équivalent à whatis
UPMC – FP – Préparation LPI - v 1.1
15
103.1 Documentation interne
[franck@localhost ~]$ whatis mkfs
mkfs (8) build a Linux file system
mkfs (8) Créer un système de fichiers Linux
mkfs.minix [mkfs] (8) Créer un système de fichiers Minix
[franck@localhost ~]$ man f mkfs
mkfs (8) build a Linux file system
mkfs (8) Créer un système de fichiers Linux
mkfs.minix [mkfs] (8) Créer un système de fichiers Minix
[franck@localhost ~]$ more /var/cache/man/whatis
3ds2m (1) Convertit les mailles (meshes) d'un fichier 3DS en u
n mfile (fichier contenant les mailles)
3dsdump (1) Affiche l'information sur la structure interne d'un
Publicité
fichier 3DS
411toppm (1) convert Sony Mavica .411 image to PPM
9wm (1) un gestionnaire de fenêtres pour X ressemblant à
a2p (1) Awk to Perl translator
a2ps (1) formate des fichiers pour impression sur une imprima
.....
UPMC – FP – Préparation LPI - v 1.1
16
103.1 Documentation interne
Commande apropos
Recherche d'une chaine de caractères dans la base de
données whatis
Le résultat est donc beaucoup moins précis
man -k est équivalent à apropos
UPMC – FP – Préparation LPI - v 1.1
17
103.1 Documentation interne
[franck@localhost ~]$ whatis mkfs
mkfs (8) build a Linux file system
mkfs (8) Créer un système de fichiers Linux
mkfs.minix [mkfs] (8) Créer un système de fichiers Minix
[franck@localhost ~]$ apropos mkfs
mke2fs [mkfs] (8) create an ext2/ext3 filesystem
mkfs (8) build a Linux file system
mkfs (8) Créer un système de fichiers Linux
mkfs.minix [mkfs] (8) Créer un système de fichiers Minix
[franck@localhost ~]$ whatis mk
mk: nothing appropriate
[franck@localhost ~]$ apropos mk
ExtUtils::Mkbootstrap (3pm) make a bootstrap file for use by DynaLoader
ExtUtils::Mksymlists (3pm) write linker options files for dynamic extension
glibmkenums (1) C language enum description generation utility
growisofs (1) combined mkisofs frontend/DVD recording program
mkbootdisk (8) créer une disquette de démarrage autonome pour le système en place
mk_cmds (1) error table compiler
......
UPMC – FP – Préparation LPI - v 1.1
18
103.1 Documentation interne
/usr/share/doc ou /usr/doc
Contient de la documentation dans un format différent des
pages man : ASCII, postscript, html, pdf.
On y trouve plutôt des tutoriels, des documentations
techniques complémentaires, des README, des HOWTO
[franck@localhost doc]$ find /usr/share/doc type f | wc l
14037
[franck@localhost doc]$ find /usr/share/doc name *.pdf | wc l
20
[franck@localhost doc]$ find /usr/share/doc name *.html | wc l
5681
[franck@localhost doc]$ find /usr/share/doc name *.ps | wc l
18
UPMC – FP – Préparation LPI - v 1.1
19
103.1 Documentation interne
... et quand on a rien trouvé comme documentation interne (le
développeur n'a pas fait son travail correctement) il reste l'aide
“codée” dans la commande
Affichage de l'aide intégrée à la commande avec option -h ou
–help ou -?
UPMC – FP – Préparation LPI - v 1.1
20
103.1 Documentation Internet
Le projet LDP (Linux Documentation Project) regroupe un
grand nombre de doc (HOWTO, Readme, guides de
référence,...)
Url à connaître : http://www.tldp.org
Publicité
http://www.gnu.org
http://www.kernel.org
Newsgroups
comp.os.linux.*
alt.os.linux
Archives newgroups
Rechercher sur http://groups.google.com
Mailing lists (listes de diffusion)
UPMC – FP – Préparation LPI - v 1.1
21
103.1 Notification utilisateurs
Fichier /etc/issue
Fichier /etc/issue.net
Fichier /etc/motd
UPMC – FP – Préparation LPI - v 1.1
22
103.1 Notification utilisateurs
/etc/issue
Fichier texte contenant un message affiché à la connexion de
l'utilisateur
Si getty le supporte, issue peut contenir les caractères @car
et \car pour la mise en forme du message
Affichage lors des connexion locales au dessus de l'invite de
login
[franck@localhost ~]$ cat /etc/issue
Fedora release 8 (Werewolf)
Kernel \r on an \m
UPMC – FP – Préparation LPI - v 1.1
23
103.1 Notification utilisateurs
/etc/issue.net
Même fonction de /etc/issue mais pour les connexions
distantes avec telnet.
Supporte les caractères de mise en forme %car supportée par
telnetd
UPMC – FP – Préparation LPI - v 1.1
24
103.1 Notification utilisateurs
/etc/motd
Message of the day
Affiche le fichier une fois l'utilisateur connecté au système
Lancé par la commande login avant d'exécuter le shell
[franck@localhost ~]$ ssh franck@localhost
franck@localhost's password:
Last login: Sat Feb 7 00:16:10 2009 from localhost.localdomain
Bienvenue sur ce système
Message spécifiques ...
Préparation LPI
UPMC – FP – Préparation LPI - v 1.1
25
Quelques conseils LPI...
Etudier rapidement les options de la commande man
(man man)
Il faut connaître les sections de manuel et quelle type d'aide
on trouve dedans
Question du type : dans quelle section doiton chercher la
commande mkdir
Connaître l'@ du site tldp
Connaître comment sont formées (à partir de quelle
commande) les bases de données apropos et whatis
UPMC – FP – Préparation LPI - v 1.1
26