[FIX] doc: change references to odoo.py to odoo-bin

2016-10-12 12:36:45 +02:00
parent a3509d282d
commit e81f186ff8
8 changed files with 36 additions and 36 deletions
@@ -20,13 +20,13 @@ Business logic and extension is generally performed on the server side,
 although supporting client features (e.g. new data representation such as
 interactive maps) can be added to the client.

-In order to start the server, simply invoke the command :ref:`odoo.py
+In order to start the server, simply invoke the command :ref:`odoo-bin
 <reference/cmdline>` in the shell, adding the full path to the file if
 necessary:

 .. code:: bash

-    odoo.py
+    odoo-bin

 The server is stopped by hitting ``Ctrl-C`` twice from the terminal, or by
 killing the corresponding OS process.
@@ -67,7 +67,7 @@ Module structure
 ----------------

 Each module is a directory within a *module directory*. Module directories
-are specified by using the :option:`--addons-path <odoo.py --addons-path>`
+are specified by using the :option:`--addons-path <odoo-bin --addons-path>`
 option.

 .. tip::
@@ -90,13 +90,13 @@ might contain::

    from . import mymodule

-Odoo provides a mechanism to help set up a new module, :ref:`odoo.py
+Odoo provides a mechanism to help set up a new module, :ref:`odoo-bin
 <reference/cmdline/server>` has a subcommand :ref:`scaffold
 <reference/cmdline/scaffold>` to create an empty module:

 .. code-block:: console

-    $ odoo.py scaffold <module name> <where to put it>
+    $ odoo-bin scaffold <module name> <where to put it>

 The command creates a subdirectory for your module, and automatically creates a
 bunch of standard files for a module. Most of them simply contain commented code
@@ -109,7 +109,7 @@ or XML. The usage of most of those files will be explained along this tutorial.

    .. only:: solutions

-        #. Invoke the command ``odoo.py scaffold openacademy addons``.
+        #. Invoke the command ``odoo-bin scaffold openacademy addons``.
        #. Adapt the manifest file to your module.
        #. Don't bother about the other files.

@@ -39,7 +39,7 @@ following command:

 This will create a ``petstore`` folder wherever you executed the command.
 You then need to add that folder to Odoo's
-:option:`addons path <odoo.py --addons-path>`, create a new database and
+:option:`addons path <odoo-bin --addons-path>`, create a new database and
 install the ``oepetstore`` module.

 If you browse the ``petstore`` folder, you should see the following content:
@@ -26,7 +26,7 @@ module. To quickly get started simply invoke:

 .. code-block:: console

-    $ ./odoo.py scaffold Academy my-modules
+    $ ./odoo-bin scaffold Academy my-modules

 This will automatically create a ``my-modules`` *module directory* with an
 ``academy`` module inside. The directory can be an existing module directory
@@ -46,7 +46,7 @@ Although it does absolutely nothing we can install it:

  .. code-block:: console

-      $ ./odoo.py --addons-path addons,my-modules
+      $ ./odoo-bin --addons-path addons,my-modules

 * go to http://localhost:8069
 * create a new database including demonstration data
@@ -70,7 +70,7 @@ Shut down your server (:kbd:`^C`) then restart it:

 .. code-block:: console

-    $ ./odoo.py --addons-path addons,my-modules
+    $ ./odoo-bin --addons-path addons,my-modules

 and open a page to http://localhost:8069/academy/academy/, you should see your
 "page" appear:
@@ -102,11 +102,11 @@ Academy` and clicking :guilabel:`Upgrade`.
 .. tip::

    Alternatively, Odoo can be restarted :option:`and update modules at
-    the same time<odoo.py -u>`:
+    the same time<odoo-bin -u>`:

    .. code-block:: console

-        $ odoo.py --addons-path addons,my-modules -d academy -u academy
+        $ odoo-bin --addons-path addons,my-modules -d academy -u academy

 Going to http://localhost:8069/academy/academy/ should now result in:

@@ -3,7 +3,7 @@
 .. _reference/cmdline:

 ===============================
-Command-line interface: odoo.py
+Command-line interface: odoo-bin
 ===============================

 .. _reference/cmdline/server:
@@ -11,7 +11,7 @@ Command-line interface: odoo.py
 Running the server
 ==================

-.. program:: odoo.py
+.. program:: odoo-bin

 .. option:: -d <database>, --database <database>

@@ -239,7 +239,7 @@ customize the amount of logging output

    .. code-block:: console

-        $ odoo.py --log-handler :DEBUG --log-handler werkzeug:CRITICAL --log-handler odoo.fields:WARNING
+        $ odoo-bin --log-handler :DEBUG --log-handler werkzeug:CRITICAL --log-handler odoo.fields:WARNING

 .. option:: --log-request

@@ -296,14 +296,14 @@ customize the amount of logging output
 Scaffolding
 ===========

-.. program:: odoo.py scaffold
+.. program:: odoo-bin 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.
+Scaffolding is available via the :command:`odoo-bin scaffold` subcommand.

 .. option:: -t <template>

@@ -344,8 +344,8 @@ Some conversions don't match the pattern:
  from configuration files

 The default configuration file is :file:`{$HOME}/.odoorc` which
-can be overridden using :option:`--config <odoo.py -c>`. Specifying
-:option:`--save <odoo.py -s>` will save the current configuration state back
+can be overridden using :option:`--config <odoo-bin -c>`. Specifying
+:option:`--save <odoo-bin -s>` will save the current configuration state back
 to that file.

 .. _jinja2: http://jinja.pocoo.org
@@ -74,7 +74,7 @@ Running tests
 -------------

 Tests are automatically run when installing or updating modules if
-:option:`--test-enable <odoo.py --test-enable>` was enabled when starting the
+:option:`--test-enable <odoo-bin --test-enable>` was enabled when starting the
 Odoo server.

 As of Odoo 8, running tests outside of the install/update cycle is not
@@ -25,7 +25,7 @@ operations or to get the data. If multi-tenancy is not used that is not an
 issue, there's only one database to use, but if there are multiple databases
 accessible Odoo needs a rule to know which one it should use.

-That is one of the purposes of :option:`--db-filter <odoo.py --db-filter>`:
+That is one of the purposes of :option:`--db-filter <odoo-bin --db-filter>`:
 it specifies the default database for the Odoo system. The value is a
 `regular expression`_, possibly including the dynamically injected hostname
 or subdomain through which the Odoo system is accessed.
@@ -156,7 +156,7 @@ increases stability, makes somewhat better use of computing resources and can
 be better monitored and resource-restricted.

 * Multiprocessing is enabled by configuring :option:`a non-zero number of
-  worker processes <odoo.py --workers>`, the number of workers should be based
+  worker processes <odoo-bin --workers>`, the number of workers should be based
  on the number of cores in the machine (possibly with some room for cron
  workers depending on how much cron work is predicted)
 * Worker limits can be configured based on the hardware configuration to avoid
@@ -185,12 +185,12 @@ LiveChat
 --------

 In multiprocessing, a dedicated LiveChat worker is automatically started and
-listening on :option:`the longpolling port <odoo.py --longpolling-port>` but
+listening on :option:`the longpolling port <odoo-bin --longpolling-port>` but
 the client will not connect to it.

 Instead you must have a proxy redirecting requests whose URL starts with
 ``/longpolling/`` to the longpolling port. Other request should be proxied to
-the :option:`normal HTTP port <odoo.py --xmlrpc-port>`
+the :option:`normal HTTP port <odoo-bin --xmlrpc-port>`

 Configuration sample
 --------------------
@@ -225,7 +225,7 @@ authentication information in cleatext. This means a secure deployment of
 Odoo must use HTTPS\ [#switching]_. SSL termination can be implemented via
 just about any SSL termination proxy, but requires the following setup:

-* enable Odoo's :option:`proxy mode <odoo.py --proxy-mode>`. This should only be enabled when Odoo is behind a reverse proxy
+* enable Odoo's :option:`proxy mode <odoo-bin --proxy-mode>`. This should only be enabled when Odoo is behind a reverse proxy
 * set up the SSL termination proxy (`Nginx termination example`_)
 * set up the proxying itself (`Nginx proxying example`_)
 * your SSL termination proxy should also automatically redirect non-secure
@@ -326,12 +326,12 @@ Cron Workers

 To run cron jobs for an Odoo deployment as a WSGI application requires

-* a classical Odoo (run via ``odoo.py``)
+* a classical Odoo (run via ``odoo-bin``)
 * connected to the database in which cron jobs have to be run (via
-  :option:`odoo.py -d`)
+  :option:`odoo-bin -d`)
 * which should not be exposed to the network. To ensure cron runners are not
  network-accessible, it is possible to disable the built-in HTTP server
-  entirely with :option:`odoo.py --no-xmlrpc` or setting ``xmlrpc = False``
+  entirely with :option:`odoo-bin --no-xmlrpc` or setting ``xmlrpc = False``
  in the configuration file

 LiveChat
@@ -355,7 +355,7 @@ The solutions to support livechat/motifications in a WSGI application are:
  the cron instance.
 * deploy an evented Odoo via ``odoo-gevent`` and proxy requests starting
  with ``/longpolling/`` to
-  :option:`the longpolling port <odoo.py --longpolling-port>`.
+  :option:`the longpolling port <odoo-bin --longpolling-port>`.

 Serving Static Files
 ====================
@@ -45,7 +45,7 @@ On Linux, using an installer

  .. code-block:: console

-    $ python /usr/bin/odoo.py -d <database_name> -u web --stop-after-init
+    $ python /usr/bin/odoo-bin -d <database_name> -u web --stop-after-init

 * You should be able to connect to your Odoo Enterprise instance using your usual mean of identification.
  You can then link your database with your Odoo Enterprise Subscription by entering the code you received
@@ -322,7 +322,7 @@ if you wish to get access), you can use this command to fetch the addons:

  $ git clone https://github.com/odoo/enterprise.git

-If you use git_, you must modify the :option:`--addons-path <odoo.py --addons-path>`
+If you use git_, you must modify the :option:`--addons-path <odoo-bin --addons-path>`
 parameter of your launch command (``init.d``, custom script, configuration file,
 etc.). The Enterprise addons folder should be included **before** the default
 addons folder.
@@ -331,7 +331,7 @@ For example:

 .. code-block:: console

-  $ odoo.py --addons-path=~/src/custom_modules,~/src/enterprise,~/src/odoo/addons
+  $ odoo-bin --addons-path=~/src/custom_modules,~/src/enterprise,~/src/odoo/addons

 .. warning:: The Enterprise git repository **does not contain the full Odoo
    source code**. You need to clone both the Community and Enterprise repository to
@@ -387,7 +387,7 @@ Source installation requires manually installing dependencies:
      then click :guilabel:`OK`.

      The user and password must be passed to Odoo using either the
-      :option:`-w <odoo.py -w>` and :option:`-r <odoo.py -r>` options or
+      :option:`-w <odoo-bin -w>` and :option:`-r <odoo-bin -r>` options or
      :ref:`the configuration file <reference/cmdline/config>`

 * Python dependencies listed in the :file:`requirements.txt` file.
@@ -484,7 +484,7 @@ Source installation requires manually installing dependencies:
 Running Odoo
 ------------

-Once all dependencies are set up, Odoo can be launched by running ``odoo.py``.
+Once all dependencies are set up, Odoo can be launched by running ``odoo-bin``.

 .. warning:: For the Enterprise edition, you must specify the :file:`enterprise`
    addons folder when starting your server. You can do so by providing the path
@@ -512,7 +512,7 @@ Under Windows a typical way to execute odoo would be:

 .. code-block:: ps1

-    C:\YourOdooPath> python odoo.py -w odoo -r odoo --addons-path=addons,../mymodules --db-filter=mydb$
+    C:\YourOdooPath> python odoo-bin -w odoo -r odoo --addons-path=addons,../mymodules --db-filter=mydb$

 Where ``odoo``, ``odoo`` are the postgresql login and password,
 ``../mymodules`` a directory with additional addons and ``mydb`` the default
@@ -522,7 +522,7 @@ Under Unix a typical way to execute odoo would be:

 .. code-block:: console

-    $ ./odoo.py --addons-path=addons,../mymodules --db-filter=mydb$
+    $ ./odoo-bin --addons-path=addons,../mymodules --db-filter=mydb$

 Where ``../mymodules`` is a directory with additional addons and ``mydb`` the
 default db to serve on localhost:8069