Comment puis-je lire la documentation sur les commandes zsh intégrées ?

Essayez l'une de ces solutions :

man zshbuiltins

ou

man zshall

Les pages de manuel pour zsh sont divisées par sujet, man zsh est principalement une table des matières et une introduction tandis que man zshall est tout (24628 lignes sur mon système contre 5242 pour man bash ).

Comme pour bindkey , man zshbuiltins vous renverra au man zshzle .

Les informations clés pour obtenir un utilitaire d'aide plus utile sont en fait incluses avec Zsh, il s'agit simplement de trouver la page de manuel critique et mal détectable :man zshcontrib (ici sur le web), qui décrit le run-help widget :

Par défaut, run-help est un alias pour le man commande, donc cela échoue souvent lorsque le mot de commande est un shell intégré ou une fonction définie par l'utilisateur. En redéfinissant le run-help alias, on peut améliorer l'aide en ligne fournie par le shell.

Il explique en outre comment le remplacer par une amélioration intégrée.

Après avoir configuré cela, appelez le run-help pour les noms des fonctions intégrées, les fonctions de complétion, etc. essaieront maintenant de vous montrer la documentation extraite, ou de vous montrer la page de manuel contenant la droite, etc. Par exemple run-help bindkey sorties :

bindkey
   See the section `Zle Builtins' in zshzle(1).

ce qui pourrait être mieux. Pour un meilleur exemple, run-help history montre la section de la page de manuel Zsh pour fc , qui est la commande qui sous-tend history .

Aussi pratique à noter :ESC-h appellera le run-help pour la commande sur la ligne d'entrée actuelle.

Je suppose que cette configuration n'est pas la valeur par défaut car l'extraction des données d'aide granulaires et la définition de HELPDIR le pointer vers cela pourrait être une décision de conditionnement laissée aux distributions de système d'exploitation. Il y a aussi un choix de l'utilisateur :le autoload run-help util est utile sans définir HELPDIR du tout. Il semble être bon pour vous amener à la bonne page de manuel même s'il ne peut pas accéder à la section exacte d'un élément. Certains peuvent préférer cela à des cas comme le bindkey exemple ci-dessus qui fait juste perdre du temps. (Pourquoi ils sont par défaut alias run-help=man alors, je ne peux pas comprendre).

Pour Zsh version 5.0.3 ou ultérieure

Le helpfiles les extractions sont probablement incluses dans la distribution Zsh. Il suffit de les trouver sur votre système pour définir HELPDIR si vous le souhaitez, les candidats sont probablement en /usr/share/zsh ou /usr/local/share/zsh , recherchez un help sous-répertoire.

Pour les versions de Zsh antérieures à 5.0.3

Vous devrez probablement suivre la procédure détaillée dans man zshcontrib vous-même pour générer les fichiers d'aide. C'est un peu ennuyeux d'avoir besoin de le faire, mais sinon c'est rapide et indolore.

Trouvez votre version installée avec zsh --version et obtenir l'archive source correspondante à partir de l'archive sourceforge. Exécutez ensuite le helpfiles script comme indiqué dans la page de manuel et définissez la cible sur HELPDIR dans votre ~/.zshrc .