GENCMDDOC

La commande GENCMDDOC (Générer doc sur commandes) permet de générer un fichier de sortie contenant la documentation d'une commande CL. Le fichier généré est disponible dans l'un des formats suivants :

• Si *HTML est indiqué pour le paramètre GENOPT (Options de génération), le fichier contient du code source HTML (HyperText Markup Language). Le fichier généré peut s'afficher dans un navigateur Web standard et est conforme aux spécifications HTML 4.0. Les informations utilisées pour générer le fichier sont extraites de l'objet *CMD indiqué et de tous les objets *PNLGRP associés à la commande.
• Si *UIM est indiqué pour le paramètre GENOPT, le fichier contient du code source UIM (Gestionnaire d'interface utilisateur). Le code source généré sert de base pour créer l'aide en ligne de la commande. Les informations utilisées pour générer le fichier sont extraites uniquement de l'objet *CMD indiqué. Cette option a été créée pour simplifier la rédaction de l'aide en ligne des commandes de langage de contrôle (CL).

  Pour plus d'informations sur la rédaction de la documentation des commandes à l'aide du Gestionnaire d'interface utilisateur, reportez-vous au manuel Rubriques CL de la catégorie Programmation de l'IBM i Information Center, à l'adresse http://www.ibm.com/systems/i/infocenter/

Restrictions :

• Vous devez disposer du droit *USE sur la commande indiquée et du droit *EXECUTE sur la bibliothèque contenant la commande. Si un nom générique ou *ALL est indiqué pour le nom de la commande, le fichier de sortie n'est pas généré pour les commandes sur lesquelles vous ne disposez pas du droit *USE.
• Pour chaque groupe de panneaux associé contenant des informations d'aide sur la commande, vous devez disposer du droit *USE sur le groupe de panneaux et du droit *EXECUTE sur la bibliothèque contenant le groupe de panneaux.
• Vous devez disposer du droit *X sur les répertoires contenant le fichier généré et des droits *WX sur le répertoire parent du fichier généré.
• Si le fichier de sortie n'existe pas, le droit public est déterminé par la valeur de propriété Java os400.file.create.auth. Si cette propriété Java n'a pas été définie, le droit public sur un fichier STREAM créé est *RW.
• Si le fichier de sortie existe déjà, vous devez disposer du droit *W sur le fichier et indiquer *YES pour le paramètre REPLACE (Remplacer fichier).
• Cette commande ne prend pas en charge les commandes proxy CL.

Paramètres

Commande (CMD)

Indique la commande pour laquelle un fichier de documentation doit être généré.

Remarque :Si un nom de commande générique ou *ALL est indiqué pour le nom de la commande, *LIBL n'est pas admis comme qualificatif de nom de bibliothèque et la valeur du paramètre TOSTMF (Fichier STREAM de destination) doit être *CMD.

Ce paramètre est obligatoire.

Qualificatif 1 : Commande

*ALL

Des fichiers de documentation doivent être générés pour toutes les commandes de la bibliothèque indiquée.

nom-générique

Indiquez le nom générique des commandes pour lesquelles des fichiers de documentation doivent être générés. Un nom générique est une chaîne de un ou plusieurs caractères suivis d'un astérisque (*). Si un nom générique est indiqué, le programme génère des fichiers de documentation pour toutes les commandes dont le nom commence par les caractères indiqués.

nom

Indiquez le nom de la commande pour laquelle vous souhaitez générer un fichier de documentation.

Qualificatif 2 : Biblio

*LIBL

La recherche porte sur toutes les bibliothèques de la liste des bibliothèques de l'unité d'exécution en cours jusqu'à ce que la première occurrence soit trouvée.

*CURLIB

La bibliothèque en cours du travail est utilisée pour localiser la commande. Si aucune bibliothèque en cours n'est précisée pour le travail, QGPL est prise par défaut.

nom

Indiquez le nom de la bibliothèque contenant la commande.

Répertoire de destination (TODIR)

Indique le répertoire dans lequel doit être stockée la documentation générée pour la commande. Le nom de fichier à utiliser dans ce répertoire est indiqué par le paramètre TOSTMF (Fichier STREAM de destination).

'.'

Le fichier de sortie est stocké dans le répertoire de travail en cours.

nom-chemin

Indiquez le nom de chemin où vous souhaitez stocker le fichier généré.

Fichier STREAM de destination (TOSTMF)

Indique le fichier STREAM cible à utiliser pour stocker le fichier de documentation généré pour la commande. Le fichier indiqué est localisé à l'aide du chemin défini pour le paramètre TODIR (Répertoire de destination).

Remarque :Si un nom de commande générique ou *ALL est indiqué pour le paramètre CMD (Commande), la valeur indiquée ou définie par défaut pour ce paramètre doit être *CMD.

*CMD

Si le paramètre TODIR indique que la cible se trouve sur le système de fichiers /QSYS.LIB, le nom de fichier généré correspond au nom de la commande.

Sinon, le nom du fichier généré dépend de la valeur indiquée (*HTML or *UIM) pour le paramètre GENOPT (Options de génération). Si *HTML est indiqué, le nom du fichier généré correspond à nombib_nomcmd.html, où nom_cmd représente le nom de la commande et nom_bib représente la bibliothèque contenant la commande. Si *UIM est indiqué, le nom de fichier généré correspond à nombib_nomcmd.uim

valeur-alphanumérique

Indiquez le nom à utiliser pour le fichier de documentation de la commande généré.

Remplacer fichier (REPLACE)

Indique si un fichier existant doit être remplacé dans le répertoire cible (paramètre TODIR) par le nom de fichier indiqué ou généré (paramètre TOSTMF).

*YES

S'il existe déjà un fichier portant le nom indiqué, son contenu est remplacé par le fichier de documentation de la commande généré.

*NO

S'il existe déjà un fichier portant le nom indiqué, un message d'erreur est envoyé et aucun fichier de documentation n'est généré. Si le répertoire cible ne contient pas de fichier portant le nom indiqué, le fichier est créé et aucun message d'erreur n'est envoyé.

Options de génération (GENOPT)

Indique les options permettant de contrôler les informations à générer sur la commande. Avec ce paramètre, vous pouvez indiquer plusieurs valeurs dans l'ordre de votre choix. Si aucune valeur n'est indiquée ou que les deux valeurs de chaque groupe sont indiquées, la valeur soulignée est utilisée.

Remarque :Les valeurs soulignées de ce paramètre sont identiques aux valeurs par défaut mais elles ne sont pas réellement les valeurs par défaut. Elles ne peuvent donc pas être modifiées par la commande CHGCMDDFT.

Option pour le code source généré

*HTML

Le fichier généré contient du code source au format HTML (HyperText Markup Language). Le fichier généré peut s'afficher dans un navigateur Web standard et est conforme aux spécifications HTML 4.0. Les informations utilisées pour générer le fichier sont extraites de l'objet *CMD indiqué et de tous les objets *PNLGRP associés à la commande.

*UIM

Le fichier généré contient le code source UIM (Gestionnaire d'interface utilisateur). Le code source généré sert de base pour créer l'aide en ligne de la commande. Les informations utilisées pour générer le fichier sont extraites uniquement de l'objet *CMD indiqué. Cette option a été créée pour simplifier la rédaction de l'aide en ligne des commandes de langage de contrôle (CL). Après avoir modifié le fichier généré pour y ajouter une description de la commande et avoir stocké le code source dans un membre de fichier source, vous pouvez utiliser ce code source UIM avec la commande CRTPNLGRP (Créer un groupe de panneaux) afin de créer un groupe de panneaux d'aide pour la commande.

Pour plus d'informations sur la rédaction de la documentation des commandes à l'aide du Gestionnaire d'interface utilisateur, reportez-vous au manuel Rubriques CL de la catégorie Programmation de l'IBM i Information Center, à l'adresse http://www.ibm.com/systems/i/infocenter/

Option pour les valeurs du programme de choix de réponses

*NOSHOWCHOICEPGMVAL

Pour les paramètres de commande associés à un programme de choix de réponse, n'affiche pas les valeurs retournées par le programme de choix de réponses dans la table récapitulative des commandes généré. Les valeurs définies pour les programmes de choix de réponses peuvent varier d'un système à l'autre. Lorsque les valeurs du programme de réponses ne sont pas affichées, seules les valeurs du paramètre définies dans l'objet commande apparaissent.

*SHOWCHOICEPGMVAL

Pour les paramètres de commande associés à un programme de choix de réponse, affiche les valeurs renvoyées par le programme de choix de réponses dans la table récapitulative des commandes généré. Les valeurs du programme de choix de réponses affichées correspondent aux paramètres indiqués lorsque vous utilisez la commande sur ce système à partir de la fonction d'invite.

Option de maintenance

*NOSERVICE

Aucune information de trace ou de cliché supplémentaire n'est générée.

*SERVICE

Cette option peut être utilisée si la commande ne fonctionne pas et que le prestataire de maintenance du logiciel vous demande de rédiger un rapport officiel d'analyse de programme (APAR) sur cet incident. L'utilisation de cette option permet de générer des informations de trace et de cliché supplémentaires. Envoyez ces informations avec le rapport officiel d'analyse de programme (APAR).

Exemples

Exemple 1 : Génération de documentation HTML pour une commande IBM i

GENCMDDOC   CMD(CRTUSRPRF)

Cette commande permet de générer un fichier de documentation pour la commande CRTUSRPRF. La liste des bibliothèques de l'unité d'exécution en cours est utilisée pour localiser la commande. Le fichier STREAM généré est stocké dans le répertoire en cours du travail. Si la commande se trouve dans la bibliothèque QSYS, le nom de fichier généré est QSYS_CRTUSRPRF.html. Si un fichier portant le nom indiqué existe déjà dans le répertoire cible, il est remplacé par le fichier généré.

Exemple 2 : Génération de la documentation UIM pour la commande utilisateur

GENCMDDOC   CMD(MYLIB/MYCMD)
            TODIR('/QSYS.LIB/MYLIB.LIB/QPNLSRC.FILE')
            TOSTMF('MYCMD.MBR')  REPLACE(*NO)  GENOPT(*UIM)

Cette commande permet de générer un fichier de documentation pour la commande MYCMD stockée dans la bibliothèque MYLIB. Le fichier généré est stocké dans le fichier QPNLSRC de la bibliothèque avec le nom de membre MYCMD. Si un membre portant ce nom existe déjà dans le fichier cible, un message d'erreur est envoyé et le fichier de documentation n'est pas généré.

Messages d'erreur

Messages *ESCAPE

CPF6E74

&1 documents de commande ont échoué. &2 documents de commande créés.

CPF6E75

Erreur détectée dans le paramètre CMD.

CPF9801

Objet &2 non trouvé dans la bibliothèque &3.

CPF9802

Non autorisé à l'objet &2 de &3.

CPF9810

Bibliothèque &1 non trouvée.

CPF9820

Non autorisé à utiliser la bibliothèque &1.

CPF9899

Erreur lors du traitement de la commande.

CPFA09C

Aucun droit sur l'objet. L'objet est &1.

CPFA0A0

L'objet existe déjà. L'objet est &1.

CPFA0A9

Objet introuvable. L'objet est &1.

CPF6E67

Documentation de commande non générée pour la commande proxy &1 dans &2.