diff --git a/doc/commands.rst b/doc/commands.rst new file mode 100644 index 00000000000..7a758b1ab2a --- /dev/null +++ b/doc/commands.rst @@ -0,0 +1,40 @@ +.. _commands: + +Available commands +================== + +This page explain some of the available ``oe`` commands. For an overview about +``oe``, see :doc:`openerp-command`. + +Keep in mind that ``oe --help`` and ``oe --help`` already give a lot +of information about the commands and their options and flags. + +``web`` +------- + +The ``web`` command is used to create a single OpenERP server process to handle +regular HTTP requests and XML-RPC requests. It is possible to execute such +process multiple times, possibly on different machines. + +It is possible to chose the ``--threaded`` or ``--gevent`` flags. It is +recommanded to use ``--threaded`` only when running a single process. +``--gevent`` is experimental; it is planned to use it for the embedded chat +feature. + +Example invocation:: + + > oe web --addons ../../addons/trunk:../../web/trunk/addons --threaded + +``cron`` +-------- + +The ``cron`` command is used to create a single OpenERP process to execute +so-called cron jobs, also called scheduled tasks in the OpenERP interface. As +for the ``web`` command, multiple cron processes can be run side by side. + +It is necessary to specify on the command-line which database need to be +watched by the cron process with the ``--database`` option. + +Example invocation:: + + > oe cron --addons ../../addons/trunk:../../web/trunk/addons --database production diff --git a/doc/index.rst b/doc/index.rst index 64fc04b552e..37870af49a8 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -25,6 +25,7 @@ OpenERP Command :maxdepth: 1 openerp-command.rst + commands.rst adding-command.rst OpenERP Server API diff --git a/doc/openerp-command.rst b/doc/openerp-command.rst index 2bfd845f8e3..6ca7b02b645 100644 --- a/doc/openerp-command.rst +++ b/doc/openerp-command.rst @@ -1,21 +1,22 @@ .. _openerp-command: -OpenERP Command -=============== +The ``oe`` script +================= The ``oe`` script provides a set of command-line tools around the OpenERP -framework. +framework. It is meant to replace the older ``openerp-server`` script (which +is still available). -Using OpenERP Command ---------------------- +Using ``oe`` +------------ In contrast to the previous ``openerp-server`` script, ``oe`` defines a few -sub-commands, each with its own set of flags and options. You can get some +commands, each with its own set of flags and options. You can get some information for any of them with :: - > oe --help + > oe --help For instance:: @@ -43,6 +44,11 @@ for instance here is a, say, ``test-trunk-view-validation.sh`` file:: # itself does not need it. oe run-tests -d ignored -m openerp.test_view_validation +Available commands +------------------- + +See the :doc:`commands` page. + Adding new commands ------------------- @@ -57,4 +63,4 @@ A preliminary ``oe-bash-completion`` file is provided. After sourcing it, > . oe-bash-completion -completion (using the TAB character) in Bash should be working. +completion (using the TAB character) in Bash should work.