goa/doc/devmanual_fr/sect_erudi-ctl.txt
author Sylvain Thénault <sylvain.thenault@logilab.fr>
Wed, 27 Jan 2010 09:56:58 +0100 (2010-01-27)
changeset 4389 14a993bc8d1e
parent 1898 39b37f90a8a4
permissions -rw-r--r--
useless, same as test_nonregr_eetype_etype_editing
L'outil `cubicweb-ctl`
-------------------
`cubicweb-ctl` est le couteau suisse pour la gestion d'instances CubicWeb.
La syntaxe g�n�rale est ::

  cubicweb-ctl <commande> [options commande] <arguments commandes>

Pour voir les commandes disponibles ::

  cubicweb-ctl
  cubicweb-ctl --help

A noter que les commandes disponibles varient en fonction des parties de CubicWeb
qui sont install�es.

Pour voir l'aide pour une commande sp�cifiques ::

  cubicweb-ctl <commande> --help

Commandes pour la cr�ation d'un composant
````````````````````````````````````````
* ``newtemplate``, cr�e un nouveau composant sur le syst�me de fichiers
  � partir du nom pass� en param�tre. Cette commande cr�e le composant � partir
  d'une squelette d'application, incluant �galement les fichiers pour le
  packaging debian)
  
Commandes pour la cr�ation d'une instance
`````````````````````````````````````````
* ``create``, cr�e les fichiers de configuration d'une instance
* ``db-create``, cr�e la base de donn�es syst�me d'une instance (tables et
  extensions uniquement)
* ``db-init``, initialise la base de donn�es syst�me d'une instance (sch�ma,
  groupes, utilisateurs, workflows...)

Par d�faut ces trois commandes sont enchain�es.

Commandes pour le lancement des instances
`````````````````````````````````````````
* ``start``, d�marre une, plusieurs, ou toutes les instances
* ``stop``, arr�t une, plusieurs, ou toutes les instances
* ``restart``, red�marre une, plusieurs, ou toutes les instances
* ``status``, donne l'�tat des instances

Commandes pour la maintenance des instances
```````````````````````````````````````````
* ``upgrade``, lance la migration d'instance(s) existante(s) lorsqu'une nouvelle
  version d'CubicWeb ou du composant est install�e
* ``shell``, ouvre un shell de migration pour maintenance manuelle d'une instance
* ``db-dump``, cr�e un dump de la base de donn�es syst�me
* ``db-restore``, restore un dump de la base de donn�es syst�me
* ``db-check``, v�rifie l'int�grit� des donn�es d'une instance. Si la correction
  automatique est activ�e, il est conseill� de faire un dump avant cette
  op�ration
* ``schema-sync``, , synchronise le sch�ma persistent d'une instance avec le sch�ma
  de l'application. Il est conseill� de faire un dump avant cette op�ration

Commandes pour la maintenance des catalogues i18n
`````````````````````````````````````````````````
* ``i18ncubicweb``, reg�n�re les catalogues de messages de la librairie CubicWeb
* ``i18ncube``, reg�n�re les catalogues de messages d'un composant
* ``i18ninstance``, recompile les catalogues de messages d'une instance. Cela est
  effectu� automatiquement lors d'une upgrade

Cf Internationalisation_.

Autres commandes
````````````````
* ``list``, donne la liste des configurations, des composants et des instances
  disponibles
* ``delete``, supprime une instance (fichiers de configuration et base de donn�es)