Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved

Chapitre 2. Utilisation

La ligne de commande type pour appeler le client est la suivante :

# ./tuleap.php [options du programme] [nom du module] [nom de la fonction] 
[paramètres de la fonction]
        

  • Options du programme :

    • -v : Verbose. Donne des détails en sortie sur ce qu'il se passe.

    • -h: Help. Affiche l'aide à propos de l'utilisation du programme.

    • --retry N: Retente l'opération N fois (Defaut: 0). Si un appel à une méthode de l'API SOAP échoue à cause d'un problème réseau, l'appel en question est ré-exécuté jusqu'a ce qu'il réussisse ou que le nombre maximum de tentatives (N) est atteint. Cette option ne présente pas de risque avec les opérations en lecture (Get*) mais il est conseillé d'être prudent avec les opérations en écriture (Add*/Update*/Delete*).

  • Nom du module : Un "module" est un groupe de fonctions qui agit sur une partie spécifique du système Tuleap. Actuellement, les modules suivants sont disponibles :

    • (vide): Si le nom du module est vide, les fonctions du noyau sont accessibles. (i.e., connection au serveur)

    • tracker: Module de gestion des Trackers

    • frs : Module de gestion desversions de fichiers

    • docman : Module de gestion de documents

  • Nom de la fonction : Le nom de la fonction à invoquer dépend du module appelé. Pour plus de détails, voir Chapitre 3. Fonctions et paramètres des modules.

  • Paramètres de la fonction : Le paramètre de la fonction dépend également de la fonction appelée. Voir Chapitre 3. Fonctions et paramètres des modules.

NOTE : les caractères accentués ne sont pas supportés dans le client en ligne de commande.

NOTE : une étoile (*) après l'argument d'une commande signifie que cet argument est obligatoire. Par exemple 'getArtifacts --tracker_id*' signifie que la commande getArtifacts doit avoir un paramètre --tracker_id pour fonctionner correctement.

Copyright © Xerox Corporation, Codendi Team, 2001-2006. All Rights Reserved