Intégrer dans VI des man pages UNIX pour la documentation PHP
You made my day dude !
C’est ce que j’aurais dis à Hannes Magnusson, développeur systèmes en Suède, quand j’ai lu son billet “Unix manual pages for PHP functions”
Il s’agit d’installer les fameuses man page UNIX pour toutes les fonctions PHP.
A quoi cela peut il bien servir ?
Tout d’abord, à avoir de la documentation en ligne de commande, sans avoir à lancer un navigateur Web. Très utile quand la connexion internet est limitée ou lorsqu’on est en train de modifier du code sur un serveur de production (ce qui bien sûr ne devrait jamais arriver).
Mais surtout, l’installation de ces pages permet d’obtenir la documentation des fonctions PHP directement dans le code PHP, dans VI, mon éditeur préféré et probablement celui de tous les vieux développeurs barbus.
Let’s rock !
Installer le package pman depuis PEAR (je ne vais pas détailler ici comment installer ou configurer PEAR) :
$ pear install doc.php.net/pman
Si vous utilisez une vielle version de PEAR, il faut ajouter doc.php.net aux repositories :
$ pear channel-discover doc.php.net
puis relancer pear install
C’est fait !
Normalement, en tapant :
$ pman strstr
On obtient une man page UNIX documentant de façon extrêmement complète la fonction PHP strstr
Enfin, pour intégrer cela dans notre éditeur préféré, ajoutez juste la ligne :
set keywordprg=pman
dans le fichier .vimrc de votre profile.
Ouvrez un fichier PHP, positionnez le curseur sur une fonction PHP et appuyez sur “K”.
Magie…. une man page apparaît avec le descriptif de la fonction pointée.
Evidemment, comparé aux nouveaux IDE surpuissants, ce n’est pas grand chose. C’est un peu comme trouver un émulateur SuperNes pour Linux, ou utiliser Lynx pour naviguer sur le web. En tout cas, ça me rappelle qu’en informatique, on peut faire de belle chose avec de petits moyens.
A bon entendeur !
Je me permet de mettre le lien vers le post original complet, il y a également quelques commentaires intéressants :
http://bjori.blogspot.com/2010/01/unix-manual-pages-for-php-functions.html
Damien
8 Jan 10 at 10:22 pm
permet toi, permet toi. Je me permet de t’indiquer que le lien est disponible dans la première phrase de ce billet.
Je cite toujours mes sources.
alheim
8 Jan 10 at 11:12 pm
effectivement je l’avais pas vu au temps pour moi.
Damien
9 Jan 10 at 6:11 pm
Il est plus intelligent de mettre la commande set keywordprg=pman dans ~/.vim/ftplugin/php.vim, par exemple, afin qu’elle ne soit éxécutée que lors de l’édition d’un fichier php (le man php lorsqu’on code en C n’est pas très utile
).
Et personnellement, je préfére cette façon de faire : http://vim.wikia.com/wiki/PHP_manual_in_Vim_help_format
fch
11 Jan 10 at 10:04 am
[...] 16, 2010 | Leave a Comment Alexandre blogged last week about how to install pman and add a contextual help within VI for PHP functions. Tthis post is merely a quick note of the procedure. I like the speed of pman as opposed to [...]
PHP Help as a Man Page (with Pear) : World Gone Web
16 Jan 10 at 12:05 am