X-Git-Url: https://git.phdru.name/?a=blobdiff_plain;f=docs%2Fbefore_begin.rst;h=1dcd27db77c5f0c0f467c230ec1d62b827bd0cfa;hb=5068288a9b724893999358a09c62031d53c825f2;hp=adc1a2c084692528e4837827f30d07fdbcf2a296;hpb=8cfaf304abebc78dbb7715505f40771dc89bae43;p=m_librarian.git diff --git a/docs/before_begin.rst b/docs/before_begin.rst index adc1a2c..1dcd27d 100644 --- a/docs/before_begin.rst +++ b/docs/before_begin.rst @@ -8,12 +8,14 @@ Before you begin you need some preparations. .. contents:: :local: +.. highlight:: none Software -------- m_Librarian is written in Python and requires Python 2.7. So install -Python 2.7 first. Install required modules: SQLObject and m_lib. +Python 2.7 first. Install required modules: SQLObject and m_lib.defenc. +pip `installs `_ required modules automatically. Library archives @@ -23,6 +25,25 @@ The program works with local library archives so download some. In addition to the very libraries you need to get INPX indices for them — m_Librarian cannot index libraries yet. +Configuration file +------------------ + +m_librarian looks up configuration file in $HOME/.config/ (if your OS is +POSIX-compatible). The configuration file must be named +``m_librarian.conf``. It must be in ``ini``-file format. The following +sections and keys are now understood:: + + [database] + URI = "database URI" + + [library] + path = "path to the library archives" + + [download] + format = "download file format" + +Most programs have an option `-C|--config file` to use a non-default +configuration file. Database -------- @@ -36,10 +57,7 @@ way of using m_Librarian. Database URI ^^^^^^^^^^^^ -For m_Librarian to use an SQL server create a configuration file and put -it in $HOME/.config/ (if your OS is POSIX-compatible). Name the -configuration file ``m_librarian.conf``. It must be in ``ini``-file -format and must have the only section ``[database]`` with the only key +In configuration file define section ``[database]`` with the only key ``URI``. The value for the key must be a Database URI in format accepted by SQLObject. Some examples::