doc review part1

bzr revid: al@openerp.com-20121113010059-efzzjaak19n1fn7s

1 files changed, 15 insertions, 280 deletions

diff --git a/doc/01_getting_started.rst b/doc/01_getting_started.rst
index 267e2759550..0403b708d47 100644
--- a/doc/01_getting_started.rst
+++ b/doc/01_getting_started.rst
@@ -155,6 +155,21 @@ You can specify alternate configuration files with ::
 
   -c CONFIG, --config=CONFIG specify alternate config file
 
+Configure addons locations
+--------------------------
+
+By default, the only directory of addons known by the server is server/bin/addons. 
+It is possible to add new addons by
+
+ - copying them in server/bin/addons, or creating a symbolic link to each 
+   of them in this directory, or
+ - specifying another directory containing addons to the server. The later 
+   can be accomplished either by running the server with the ``--addons-path=`` 
+   option, or by configuring this option in the openerp_serverrc file, 
+   automatically generated under Linux in your home directory by the 
+   server when executed with the ``--save`` option. You can provide several 
+   addons to the ``addons_path`` = option, separating them using commas.
+
 Start-up script
 ===============
 
@@ -173,283 +188,3 @@ Yet another alternative is to use a WSGI-compatible HTTP server and let it call
 into one of the WSGI entry points of the server.
 
 
-Appendix
-========
-
-Command line options example
-++++++++++++++++++++++++++++
-
-Usage: openerp-server [options]
-
-**Options**::
-
-  --version             show program's version number and exit
-  -h, --help            show this help message and exit
-
-**Common options**::
-
-    -c CONFIG, --config=CONFIG
-                        specify alternate config file
-    -s, --save          save configuration to ~/.openerp_serverrc
-    -i INIT, --init=INIT
-                        install one or more modules (comma-separated list, use
-                        "all" for all modules), requires -d
-    -u UPDATE, --update=UPDATE
-                        update one or more modules (comma-separated list, use
-                        "all" for all modules). Requires -d.
-    --without-demo=WITHOUT_DEMO
-                        disable loading demo data for modules to be installed
-                        (comma-separated, use "all" for all modules). Requires
-                        -d and -i. Default is none
-    -P IMPORT_PARTIAL, --import-partial=IMPORT_PARTIAL
-                        Use this for big data importation, if it crashes you
-                        will be able to continue at the current state. Provide
-                        a filename to store intermediate importation states.
-    --pidfile=PIDFILE   file where the server pid will be stored
-    --addons-path=ADDONS_PATH
-                        specify additional addons paths (separated by commas).
-    --load=SERVER_WIDE_MODULES
-                        Comma-separated list of server-wide modules
-                        default=web
-
-**XML-RPC Configuration**::
-
-    --xmlrpc-interface=XMLRPC_INTERFACE
-                        Specify the TCP IP address for the XML-RPC protocol.
-                        The empty string binds to all interfaces.
-    --xmlrpc-port=XMLRPC_PORT
-                        specify the TCP port for the XML-RPC protocol
-    --no-xmlrpc         disable the XML-RPC protocol
-    --proxy-mode        Enable correct behavior when behind a reverse proxy
-
-**XML-RPC Secure Configuration**::
-
-    --xmlrpcs-interface=XMLRPCS_INTERFACE
-                        Specify the TCP IP address for the XML-RPC Secure
-                        protocol. The empty string binds to all interfaces.
-    --xmlrpcs-port=XMLRPCS_PORT
-                        specify the TCP port for the XML-RPC Secure protocol
-    --no-xmlrpcs        disable the XML-RPC Secure protocol
-    --cert-file=SECURE_CERT_FILE
-                        specify the certificate file for the SSL connection
-    --pkey-file=SECURE_PKEY_FILE
-                        specify the private key file for the SSL connection
-
-**NET-RPC Configuration**::
-
-    --netrpc-interface=NETRPC_INTERFACE
-                        specify the TCP IP address for the NETRPC protocol
-    --netrpc-port=NETRPC_PORT
-                        specify the TCP port for the NETRPC protocol
-    --no-netrpc         disable the NETRPC protocol
-
-**Web interface Configuration**::
-
-    --db-filter=REGEXP  Filter listed database
-
-**Static HTTP service**::
-
-    --static-http-enable
-                        enable static HTTP service for serving plain HTML
-                        files
-    --static-http-document-root=STATIC_HTTP_DOCUMENT_ROOT
-                        specify the directory containing your static HTML
-                        files (e.g '/var/www/')
-    --static-http-url-prefix=STATIC_HTTP_URL_PREFIX
-                        specify the URL root prefix where you want web
-                        browsers to access your static HTML files (e.g '/')
-
-**Testing Configuration**::
-
-    --test-file=TEST_FILE
-                        Launch a YML test file.
-    --test-report-directory=TEST_REPORT_DIRECTORY
-                        If set, will save sample of all reports in this
-                        directory.
-    --test-enable       Enable YAML and unit tests.
-    --test-commit       Commit database changes performed by YAML or XML
-                        tests.
-
-**Logging Configuration**::
-
-    --logfile=LOGFILE   file where the server log will be stored
-    --no-logrotate      do not rotate the logfile
-    --syslog            Send the log to the syslog server
-    --log-handler=PREFIX:LEVEL
-                        setup a handler at LEVEL for a given PREFIX. An empty
-                        PREFIX indicates the root logger. This option can be
-                        repeated. Example: "openerp.orm:DEBUG" or
-                        "werkzeug:CRITICAL" (default: ":INFO")
-    --log-request       shortcut for --log-
-                        handler=openerp.netsvc.rpc.request:DEBUG
-    --log-response      shortcut for --log-
-                        handler=openerp.netsvc.rpc.response:DEBUG
-    --log-web           shortcut for --log-
-                        handler=openerp.addons.web.common.http:DEBUG
-    --log-sql           shortcut for --log-handler=openerp.sql_db:DEBUG
-    --log-level=LOG_LEVEL
-                        specify the level of the logging. Accepted values:
-                        ['info', 'debug_rpc', 'warn', 'test', 'critical',
-                        'debug_sql', 'error', 'debug', 'debug_rpc_answer',
-                        'notset'] (deprecated option).
-
-**SMTP Configuration**::
-
-    --email-from=EMAIL_FROM
-                        specify the SMTP email address for sending email
-    --smtp=SMTP_SERVER  specify the SMTP server for sending email
-    --smtp-port=SMTP_PORT
-                        specify the SMTP port
-    --smtp-ssl          specify the SMTP server support SSL or not
-    --smtp-user=SMTP_USER
-                        specify the SMTP username for sending email
-    --smtp-password=SMTP_PASSWORD
-                        specify the SMTP password for sending email
-
-**Database related options**::
-
-    -d DB_NAME, --database=DB_NAME
-                        specify the database name
-    -r DB_USER, --db_user=DB_USER
-                        specify the database user name
-    -w DB_PASSWORD, --db_password=DB_PASSWORD
-                        specify the database password
-    --pg_path=PG_PATH   specify the pg executable path
-    --db_host=DB_HOST   specify the database host
-    --db_port=DB_PORT   specify the database port
-    --db_maxconn=DB_MAXCONN
-                        specify the the maximum number of physical connections
-                        to posgresql
-    --db-template=DB_TEMPLATE
-                        specify a custom database template to create a new
-                        database
-
-**Internationalisation options**::
-
-    Use these options to translate OpenERP to another language.See i18n
-    section of the user manual. Option '-d' is mandatory.Option '-l' is
-    mandatory in case of importation
-
-    --load-language=LOAD_LANGUAGE
-                        specifies the languages for the translations you want
-                        to be loaded
-    -l LANGUAGE, --language=LANGUAGE
-                        specify the language of the translation file. Use it
-                        with --i18n-export or --i18n-import
-    --i18n-export=TRANSLATE_OUT
-                        export all sentences to be translated to a CSV file, a
-                        PO file or a TGZ archive and exit
-    --i18n-import=TRANSLATE_IN
-                        import a CSV or a PO file with translations and exit.
-                        The '-l' option is required.
-    --i18n-overwrite    overwrites existing translation terms on updating a
-                        module or importing a CSV or a PO file.
-    --modules=TRANSLATE_MODULES
-                        specify modules to export. Use in combination with
-                        --i18n-export
-
-**Security-related options**::
-
-    --no-database-list  disable the ability to return the list of databases
-
-**Advanced options**::
-
-    --cache-timeout=CACHE_TIMEOUT
-                        set the timeout for the cache system
-    --debug             enable debug mode
-    --stop-after-init   stop the server after its initialization
-    -t TIMEZONE, --timezone=TIMEZONE
-                        specify reference timezone for the server (e.g.
-                        Europe/Brussels
-    --osv-memory-count-limit=OSV_MEMORY_COUNT_LIMIT
-                        Force a limit on the maximum number of records kept in
-                        the virtual osv_memory tables. The default is False,
-                        which means no count-based limit.
-    --osv-memory-age-limit=OSV_MEMORY_AGE_LIMIT
-                        Force a limit on the maximum age of records kept in
-                        the virtual osv_memory tables. This is a decimal value
-                        expressed in hours, and the default is 1 hour.
-    --max-cron-threads=MAX_CRON_THREADS
-                        Maximum number of threads processing concurrently cron
-                        jobs.
-    --virtual-memory-limit=VIRTUAL_MEMORY_LIMIT
-                        Maximum allowed virtual memory per Gunicorn process.
-                        When the limit is reached, any memory allocation will
-                        fail.
-    --virtual-memory-reset=VIRTUAL_MEMORY_RESET
-                        Maximum allowed virtual memory per Gunicorn process.
-                        When the limit is reached, the worker will be reset
-                        after the current request.
-    --cpu-time-limit=CPU_TIME_LIMIT
-                        Maximum allowed CPU time per Gunicorn process. When
-                        the limit is reached, an exception is raised.
-    --unaccent          Use the unaccent function provided by the database
-                        when available.
-
-Server configuration file
-+++++++++++++++++++++++++
-
-::
-
-  [options]
-  addons_path = /home/openerp/workspace/openerp-dev/addons/trunk,/home/openerp/workspace/openerp-dev/web/trunk/addons
-  admin_passwd = admin
-  cache_timeout = 100000
-  cpu_time_limit = 60
-  csv_internal_sep = ,
-  db_host = False
-  db_maxconn = 64
-  db_name = False
-  db_password = False
-  db_port = False
-  db_template = template0
-  db_user = openerp
-  dbfilter = .*
-  debug_mode = False
-  demo = {}
-  email_from = False
-  import_partial = 
-  list_db = True
-  log_handler = [':INFO']
-  log_level = info
-  logfile = False
-  login_message = False
-  logrotate = True
-  max_cron_threads = 4
-  netrpc = True
-  netrpc_interface = 
-  netrpc_port = 8070
-  osv_memory_age_limit = 1.0
-  osv_memory_count_limit = False
-  pg_path = None
-  pidfile = False
-  proxy_mode = False
-  reportgz = False
-  secure_cert_file = server.cert
-  secure_pkey_file = server.pkey
-  server_wide_modules = None
-  smtp_password = False
-  smtp_port = 25
-  smtp_server = localhost
-  smtp_ssl = False
-  smtp_user = False
-  static_http_document_root = None
-  static_http_enable = False
-  static_http_url_prefix = None
-  syslog = False
-  test_commit = False
-  test_enable = False
-  test_file = False
-  test_report_directory = False
-  timezone = False
-  translate_modules = ['all']
-  unaccent = False
-  virtual_memory_limit = 805306368
-  virtual_memory_reset = 671088640
-  without_demo = False
-  xmlrpc = True
-  xmlrpc_interface = 
-  xmlrpc_port = 8069
-  xmlrpcs = True
-  xmlrpcs_interface = 
-  xmlrpcs_port = 8071