Add option -C|--config file

[m_librarian.git] / docs / before_begin.rst

diff --git a/docs/before_begin.rst b/docs/before_begin.rst
index a2c13b069562fcb49e34da589780802cf346e0d1..abbb1187957aaa8f988b4beaef21994e18c5f19e 100644 (file)
--- a/docs/before_begin.rst
+++ b/docs/before_begin.rst
@@ -24,6 +24,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
 --------
@@ -37,10 +56,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::