doc/reference/cmdline.rst

   1 .. _reference/cmdline:
   2
   3 ===============================
   4 Command-line interface: oodo.py
   5 ===============================
   6
   7 .. _reference/cmdline/server:
   8
   9 Running the server
  10 ==================
  11
  12 .. program:: odoo.py
  13
  14 .. option:: -d <database>, --database=<database>
  15
  16     database used when installing or updating modules.
  17
  18 .. option:: -i <modules>, --init=<modules>
  19
  20     comma-separated list of modules to :ref:`install
  21     <reference/module/lifecycle/install>` before running the server.
  22
  23 .. option:: -u <modules>, --update=<modules>
  24
  25     comma-separated list of modules to :ref:`update
  26     <reference/module/lifecycle/update>` before running the server.
  27
  28 .. option:: --addons-path <directories>
  29
  30     comma-separated list of directories in which modules are stored. These
  31     directories are scanned for modules (nb: when and why?)
  32
  33 .. option:: -c <config>, --config <config>
  34
  35     provide an alternate configuration file
  36
  37 .. option:: -s, --save
  38
  39     saves the server configuration to the current configuration file
  40     (:file:`{$HOME}/.openerp_serverrc` by default, overridable using
  41     :option:`-c`)
  42
  43 .. _reference/cmdline/scaffold:
  44
  45 Scaffolding
  46 ===========
  47
  48 .. program:: odoo.py scaffold
  49
  50 Scaffolding is the automated creation of a skeleton structure to simplify
  51 bootstrapping (of new modules, in the case of Odoo). While not necessary it
  52 avoids the tedium of setting up basic structures and looking up what all
  53 starting requirements are.
  54
  55 Scaffolding is available via the :command:`odoo.py scaffold` subcommand.
  56
  57 .. option:: -t <template>
  58
  59     a template directory, files are passed through jinja2_ then copied to
  60     the :option:`destination` directory
  61
  62 .. option:: name
  63
  64     the name of the module to create, may munged in various manners to
  65     generate programmatic names (e.g. module directory name, model names, …)
  66
  67 .. option:: destination
  68
  69     directory in which to create the new module, defaults to the current
  70     directory
  71
  72 .. _reference/cmdline/config:
  73
  74 Configuration file
  75 ==================
  76
  77 Most of the command-line options can also be specified via a configuration
  78 file.
  79
  80 The default configuration file is :file:`{$HOME}/.openerp_serverrc` which
  81 can be overridden using :option:`--config <odoo.py -c>`. Specifying
  82 :option:`--save <odoo.py -s>` will save the current configuration state back
  83 to that file.
  84
  85 .. _jinja2: http://jinja.pocoo.org