Update docs: m_librarian requires Python 2.7 or 3.4+

[m_librarian.git] / docs-ru / before_begin.rst

diff --git a/docs-ru/before_begin.rst b/docs-ru/before_begin.rst
index e23543a179d7529b688dbd30b28b4a1e87b68331..555db2b1729ec5198dbe4b63f3c5668096b5345e 100644 (file)
--- a/docs-ru/before_begin.rst
+++ b/docs-ru/before_begin.rst
@@ -8,12 +8,14 @@
 .. contents::
    :local:
 
+.. highlight:: none
 
 Программное обеспечение
 -----------------------
 
 m_Librarian написан на языке Python, так что вам нужно скачать и
-установить Python 2.7. Нужны также библиотеки SQLObject и m_lib.
+установить Python (2.7 или 3.4+). Нужны также библиотеки SQLObject и
+m_lib.defenc.
 
 
 Архивы библиотек
@@ -43,6 +45,26 @@ m_Librarian пока не научился индексировать архив
 | http://home-lib.net/download/inpx/librusec_local_all.inpx
 
 
+Файл конфигурации
+-----------------
+
+Файл конфигурации по умолчанию ищется в $HOME/.config/ (если у вас
+POSIX-совместимая ОС). Файл должен называться ``m_librarian.conf``. Это
+должен быть файл в формате ``ini``. В настоящий момент m_librarian
+понимает следующие секции и ключи в них::
+
+    [database]
+    URI = "DB URI"
+
+    [library]
+    path = "путь к архивам библиотеки"
+
+    [download]
+    format = "формат имён сохраняемых файлов"
+
+Большинство программ имею опцию `-C|--config config`, которая позволяет
+использовать файл произвольный конфигурации.
+
 База данных
 -----------
 
@@ -52,5 +74,25 @@ m_Librarian пока не научился индексировать архив
 вам придётся создать самим. Для SQLite файл БД будет создан программой,
 так что это наиболее простой способ использования m_Librarian,
 
+Database URI
+^^^^^^^^^^^^
+
+Чтобы m_Librarian использовал сервер SQL в файле конфигурации должна
+быть секция ``[database]`` с единственным ключом ``URI``. Значением
+ключа должно быть Database URI в формате, который понимает SQLObject.
+Вот несколько примеров::
+
+   [database]
+   URI = mysql://user:password@host/database
+
+   [database]
+   URI = postgres://user@host/database
+
+   [database]
+   URI = sqlite:///full/path/to/database
+
+Больше примеров есть в файле sample/m_librarian.conf. Детальное описание
+DB URI есть в `документации на SQLObject
+<http://sqlobject.org/SQLObject.html#declaring-a-connection>`_.
 
 .. vim: set tw=72 :