# HG changeset patch # User Aurelien Campeas # Date 1292320868 -3600 # Node ID 839bb40990cae5401bde1eabf084e6b2ba209239 # Parent db1e9e733a16ad1ba0e5cb8132e222249937fa5f [doc/book] move ctl tool in Admin chapter (from Appendages) diff -r db1e9e733a16 -r 839bb40990ca doc/book/en/admin/cubicweb-ctl.rst --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/doc/book/en/admin/cubicweb-ctl.rst Tue Dec 14 11:01:08 2010 +0100 @@ -0,0 +1,122 @@ +.. -*- coding: utf-8 -*- + +.. _cubicweb-ctl: + +``cubicweb-ctl`` tool +===================== + +`cubicweb-ctl` is the swiss knife to manage *CubicWeb* instances. +The general syntax is :: + + cubicweb-ctl [options command] + +To view available commands :: + + cubicweb-ctl + cubicweb-ctl --help + +Please note that the commands available depends on the *CubicWeb* packages +and cubes that have been installed. + +To view the help menu on specific command :: + + cubicweb-ctl --help + +Listing available cubes and instance +------------------------------------- + +* ``list``, provides a list of the available configuration, cubes + and instances. + + +Creation of a new cube +----------------------- + +Create your new cube cube :: + + cubicweb-ctl newcube + +This will create a new cube in +``/path/to/forest/cubicweb/cubes/`` for a Mercurial forest +installation, or in ``/usr/share/cubicweb/cubes`` for a debian +packages installation. + +Create an instance +------------------- + +You must ensure `~/cubicweb.d/` exists prior to this. On windows, the +'~' part will probably expand to 'Documents and Settings/user'. + +To create an instance from an existing cube, execute the following +command :: + + cubicweb-ctl create + +This command will create the configuration files of an instance in +``~/etc/cubicweb.d/``. + +The tool ``cubicweb-ctl`` executes the command ``db-create`` and +``db-init`` when you run ``create`` so that you can complete an +instance creation in a single command. But of course it is possible +to issue these separate commands separately, at a later stage. + +Command to create/initialize an instance database +------------------------------------------------- + +* ``db-create``, creates the system database of an instance (tables and + extensions only) +* ``db-init``, initializes the system database of an instance + (schema, groups, users, workflows...) + +Commands to control instances +----------------------------- + +* ``start``, starts one or more or all instances + +of special interest:: + + start -D + +will start in debug mode (under windows, starting without -D will not +work; you need instead to setup your instance as a service). + +* ``stop``, stops one or more or all instances +* ``restart``, restarts one or more or all instances +* ``status``, returns the status of the instance(s) + +Commands to maintain instances +------------------------------ + +* ``upgrade``, launches the existing instances migration when a new version + of *CubicWeb* or the cubes installed is available +* ``shell``, opens a (Python based) migration shell for manual maintenance of the instance +* ``db-dump``, creates a dump of the system database +* ``db-restore``, restores a dump of the system database +* ``db-check``, checks data integrity of an instance. If the automatic correction + is activated, it is recommanded to create a dump before this operation. +* ``schema-sync``, synchronizes the persistent schema of an instance with + the instance schema. It is recommanded to create a dump before this operation. + +Commands to maintain i18n catalogs +---------------------------------- +* ``i18ncubicweb``, regenerates messages catalogs of the *CubicWeb* library +* ``i18ncube``, regenerates the messages catalogs of a cube +* ``i18ninstance``, recompiles the messages catalogs of an instance. + This is automatically done while upgrading. + +See also chapter :ref:`internationalization`. + +Other commands +-------------- +* ``delete``, deletes an instance (configuration files and database) + +Command to create an instance for Google AppEngine datastore source +------------------------------------------------------------------- +* ``newgapp``, creates the configuration files for an instance + +This command needs to be followed by the commands responsible for +the database initialization. As those are specific to the `datastore`, +specific Google AppEgine database, they are not available for now +in cubicweb-ctl, but they are available in the instance created. + +For more details, please see :ref:`GoogleAppEngineSource` . diff -r db1e9e733a16 -r 839bb40990ca doc/book/en/admin/index.rst --- a/doc/book/en/admin/index.rst Tue Dec 14 10:39:20 2010 +0100 +++ b/doc/book/en/admin/index.rst Tue Dec 14 11:01:08 2010 +0100 @@ -14,6 +14,7 @@ :numbered: setup + cubicweb-ctl create-instance instance-config site-config diff -r db1e9e733a16 -r 839bb40990ca doc/book/en/annexes/cubicweb-ctl.rst --- a/doc/book/en/annexes/cubicweb-ctl.rst Tue Dec 14 10:39:20 2010 +0100 +++ /dev/null Thu Jan 01 00:00:00 1970 +0000 @@ -1,122 +0,0 @@ -.. -*- coding: utf-8 -*- - -.. _cubicweb-ctl: - -``cubicweb-ctl`` tool -===================== - -`cubicweb-ctl` is the swiss knife to manage *CubicWeb* instances. -The general syntax is :: - - cubicweb-ctl [options command] - -To view available commands :: - - cubicweb-ctl - cubicweb-ctl --help - -Please note that the commands available depends on the *CubicWeb* packages -and cubes that have been installed. - -To view the help menu on specific command :: - - cubicweb-ctl --help - -Listing available cubes and instance -------------------------------------- - -* ``list``, provides a list of the available configuration, cubes - and instances. - - -Creation of a new cube ------------------------ - -Create your new cube cube :: - - cubicweb-ctl newcube - -This will create a new cube in -``/path/to/forest/cubicweb/cubes/`` for a Mercurial forest -installation, or in ``/usr/share/cubicweb/cubes`` for a debian -packages installation. - -Create an instance -------------------- - -You must ensure `~/cubicweb.d/` exists prior to this. On windows, the -'~' part will probably expand to 'Documents and Settings/user'. - -To create an instance from an existing cube, execute the following -command :: - - cubicweb-ctl create - -This command will create the configuration files of an instance in -``~/etc/cubicweb.d/``. - -The tool ``cubicweb-ctl`` executes the command ``db-create`` and -``db-init`` when you run ``create`` so that you can complete an -instance creation in a single command. But of course it is possible -to issue these separate commands separately, at a later stage. - -Command to create/initialize an instance database -------------------------------------------------- - -* ``db-create``, creates the system database of an instance (tables and - extensions only) -* ``db-init``, initializes the system database of an instance - (schema, groups, users, workflows...) - -Commands to control instances ------------------------------ - -* ``start``, starts one or more or all instances - -of special interest:: - - start -D - -will start in debug mode (under windows, starting without -D will not -work; you need instead to setup your instance as a service). - -* ``stop``, stops one or more or all instances -* ``restart``, restarts one or more or all instances -* ``status``, returns the status of the instance(s) - -Commands to maintain instances ------------------------------- - -* ``upgrade``, launches the existing instances migration when a new version - of *CubicWeb* or the cubes installed is available -* ``shell``, opens a (Python based) migration shell for manual maintenance of the instance -* ``db-dump``, creates a dump of the system database -* ``db-restore``, restores a dump of the system database -* ``db-check``, checks data integrity of an instance. If the automatic correction - is activated, it is recommanded to create a dump before this operation. -* ``schema-sync``, synchronizes the persistent schema of an instance with - the instance schema. It is recommanded to create a dump before this operation. - -Commands to maintain i18n catalogs ----------------------------------- -* ``i18ncubicweb``, regenerates messages catalogs of the *CubicWeb* library -* ``i18ncube``, regenerates the messages catalogs of a cube -* ``i18ninstance``, recompiles the messages catalogs of an instance. - This is automatically done while upgrading. - -See also chapter :ref:`internationalization`. - -Other commands --------------- -* ``delete``, deletes an instance (configuration files and database) - -Command to create an instance for Google AppEngine datastore source -------------------------------------------------------------------- -* ``newgapp``, creates the configuration files for an instance - -This command needs to be followed by the commands responsible for -the database initialization. As those are specific to the `datastore`, -specific Google AppEgine database, they are not available for now -in cubicweb-ctl, but they are available in the instance created. - -For more details, please see :ref:`GoogleAppEngineSource` . diff -r db1e9e733a16 -r 839bb40990ca doc/book/en/annexes/index.rst --- a/doc/book/en/annexes/index.rst Tue Dec 14 10:39:20 2010 +0100 +++ b/doc/book/en/annexes/index.rst Tue Dec 14 11:01:08 2010 +0100 @@ -13,7 +13,6 @@ :numbered: faq - cubicweb-ctl rql/index mercurial depends