Add env vars and tweaks to user manual

This commit is contained in:
Kovid Goyal 2010-06-07 11:17:35 -06:00
parent c9f7480db8
commit 27a8bbdc37

View File

@ -19,12 +19,20 @@ use *plugins* to add funtionality to |app|.
Environment variables Environment variables
----------------------- -----------------------
* ``CALIBRE_CONFIG_DIRECTORY`` * ``CALIBRE_CONFIG_DIRECTORY`` - sets the directory where configuration files are stored/read.
* ``CALIBRE_OVERRIDE_DATABASE_PATH`` * ``CALIBRE_OVERRIDE_DATABASE_PATH`` - allows you to specify the full path to metadata.db. Using this variable you can have metadata.db be in a location other than the library folder. Useful if your library folder is on a networked drive that does not support file locking.
* ``CALIBRE_DEVELOP_FROM`` * ``CALIBRE_DEVELOP_FROM`` - Used to run from a calibre development environment. See :ref:`develop`.
* ``CALIBRE_OVERRIDE_LANG`` * ``CALIBRE_OVERRIDE_LANG`` - Used to force the language used by the interface (ISO 639 language code)
* ``SYSFS_PATH`` * ``SYSFS_PATH`` - Use if sysfs is mounted somewhere other than /sys
* ``http_proxy`` * ``http_proxy`` - Used on linux to specify an HTTP proxy
Tweaks
------------
Tweaks are small changes that you can specify to control various aspects of |app|'s behavior. You specify them by editing the 2tweaks.py file in the config directory.
The default tweaks.py file is reproduced below
.. literalinclude:: ../../../resources/default_tweaks.py
A Hello World plugin A Hello World plugin