diff options
| author | Raphael Collet <rco@openerp.com> | 2014-08-22 17:51:20 +0200 |
|---|---|---|
| committer | Raphael Collet <rco@openerp.com> | 2014-08-22 17:51:20 +0200 |
| commit | 2ad092b5e54fa39a906b38d9240e08b9800ea0da (patch) | |
| tree | 1879c2a6efe8ed1626d92635870aaff922306492 /doc/reference/cmdline.rst | |
| parent | 97256fa1fba6c7d3d02962b5948158d17852cf43 (diff) | |
[ADD] doc: new documentation, with training tutorials, and new scaffolding
Diffstat (limited to 'doc/reference/cmdline.rst')
| -rw-r--r-- | doc/reference/cmdline.rst | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/doc/reference/cmdline.rst b/doc/reference/cmdline.rst new file mode 100644 index 00000000000..dcedbe03eba --- /dev/null +++ b/doc/reference/cmdline.rst @@ -0,0 +1,85 @@ +.. _reference/cmdline: + +=============================== +Command-line interface: oodo.py +=============================== + +.. _reference/cmdline/server: + +Running the server +================== + +.. program:: odoo.py + +.. option:: -d <database>, --database=<database> + + database used when installing or updating modules. + +.. option:: -i <modules>, --init=<modules> + + comma-separated list of modules to :ref:`install + <reference/module/lifecycle/install>` before running the server. + +.. option:: -u <modules>, --update=<modules> + + comma-separated list of modules to :ref:`update + <reference/module/lifecycle/update>` before running the server. + +.. option:: --addons-path <directories> + + comma-separated list of directories in which modules are stored. These + directories are scanned for modules (nb: when and why?) + +.. option:: -c <config>, --config <config> + + provide an alternate configuration file + +.. option:: -s, --save + + saves the server configuration to the current configuration file + (:file:`{$HOME}/.openerp_serverrc` by default, overridable using + :option:`-c`) + +.. _reference/cmdline/scaffold: + +Scaffolding +=========== + +.. program:: odoo.py scaffold + +Scaffolding is the automated creation of a skeleton structure to simplify +bootstrapping (of new modules, in the case of Odoo). While not necessary it +avoids the tedium of setting up basic structures and looking up what all +starting requirements are. + +Scaffolding is available via the :command:`odoo.py scaffold` subcommand. + +.. option:: -t <template> + + a template directory, files are passed through jinja2_ then copied to + the :option:`destination` directory + +.. option:: name + + the name of the module to create, may munged in various manners to + generate programmatic names (e.g. module directory name, model names, …) + +.. option:: destination + + directory in which to create the new module, defaults to the current + directory + +.. _reference/cmdline/config: + +Configuration file +================== + +Most of the command-line options can also be specified via a configuration +file. + +The default configuration file is :file:`{$HOME}/.openerp_serverrc` which +can be overridden using :option:`--config <odoo.py -c>`. Specifying +:option:`--save <odoo.py -s>` will save the current configuration state back +to that file. + +.. _jinja2: http://jinja.pocoo.org |
