[DOC] added prose for oe web and oe cron.
bzr revid: vmt@openerp.com-20130118144750-lddby5a526092vdi
This commit is contained in:
parent
8b8f9249b5
commit
83b49ff625
|
@ -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 <command> --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
|
|
@ -25,6 +25,7 @@ OpenERP Command
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
openerp-command.rst
|
openerp-command.rst
|
||||||
|
commands.rst
|
||||||
adding-command.rst
|
adding-command.rst
|
||||||
|
|
||||||
OpenERP Server API
|
OpenERP Server API
|
||||||
|
|
|
@ -1,21 +1,22 @@
|
||||||
.. _openerp-command:
|
.. _openerp-command:
|
||||||
|
|
||||||
OpenERP Command
|
The ``oe`` script
|
||||||
===============
|
=================
|
||||||
|
|
||||||
The ``oe`` script provides a set of command-line tools around the OpenERP
|
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
|
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
|
information for any of them with
|
||||||
|
|
||||||
::
|
::
|
||||||
|
|
||||||
> oe <sub-command> --help
|
> oe <command> --help
|
||||||
|
|
||||||
For instance::
|
For instance::
|
||||||
|
|
||||||
|
@ -43,6 +44,11 @@ for instance here is a, say, ``test-trunk-view-validation.sh`` file::
|
||||||
# itself does not need it.
|
# itself does not need it.
|
||||||
oe run-tests -d ignored -m openerp.test_view_validation
|
oe run-tests -d ignored -m openerp.test_view_validation
|
||||||
|
|
||||||
|
Available commands
|
||||||
|
-------------------
|
||||||
|
|
||||||
|
See the :doc:`commands` page.
|
||||||
|
|
||||||
Adding new commands
|
Adding new commands
|
||||||
-------------------
|
-------------------
|
||||||
|
|
||||||
|
@ -57,4 +63,4 @@ A preliminary ``oe-bash-completion`` file is provided. After sourcing it,
|
||||||
|
|
||||||
> . oe-bash-completion
|
> . oe-bash-completion
|
||||||
|
|
||||||
completion (using the TAB character) in Bash should be working.
|
completion (using the TAB character) in Bash should work.
|
||||||
|
|
Loading…
Reference in New Issue