Преглед изворни кода

update docs about the lock_timeout option

Oz N Tiram пре 8 година
родитељ
комит
021a8b9a2a
1 измењених фајлова са 17 додато и 14 уклоњено
  1. 17 14
      docs/source/configuration.rst

+ 17 - 14
docs/source/configuration.rst

@@ -1,14 +1,14 @@
 Configuring Pwman3
-================== 
+==================
 
 By default Pwman3 will read the configuration file from the following path::
 
-    ~/.pwman/config 
+    ~/.pwman/config
 
-This is the ``PWMAN_CONFIG`` following. 
+This is the ``PWMAN_CONFIG`` following.
 
-You can override this by giving the ``-c <Config File>`` at the commnad line 
-when starting Pwman3. 
+You can override this by giving the ``-c <Config File>`` at the commnad line
+when starting Pwman3.
 
 The configuration file has the following structure::
 
@@ -16,7 +16,7 @@ The configuration file has the following structure::
     Option = Value
 
 The following is an example default config file::
-    
+
     [Readline]
     history = <PWMAN_CONFIG>/history
 
@@ -27,10 +27,11 @@ The following is an example default config file::
     umask = 0100
     cls_timeout = 10
     xsel = /usr/bin/xsel
+    lock_timeout = 60
 
     [Database]
     filename = sqlite:///<PWMAN_CONFIG>/pwman.db`
-    
+
     [Updater]
     supress_version_check = no
     client_info = ee5cd64310568736b971e3fb7c7064a4459b99a2b78672515fd0f06c82f65d5
@@ -40,12 +41,12 @@ Following is a table describing the parameters and their meanings:
 
 
     =====================    ===========
-    **Section**              *Readline* 
+    **Section**              *Readline*
     ---------------------    -----------
                              *Global*
     history                  path to the file containing history of commands typed
     ---------------------    -----------
-    **Section**              *Global* 
+    **Section**              *Global*
     ---------------------    -----------
     save                     True or False - whether the Configuring file should be saved
     ---------------------    -----------
@@ -57,19 +58,21 @@ Following is a table describing the parameters and their meanings:
     ---------------------    -----------
     umask                    The umask in which database and configuration files are written.
     ---------------------    -----------
-    xsel                     path to the xsel binary (Linux\BSD only) 
+    xsel                     path to the xsel binary (Linux\BSD only).
+    ---------------------    -----------
+    lock_timeout             set the period (in secods) after which the database is locked.
     ---------------------    -----------
-    **Section**              *Database* 
+    **Section**              *Database*
     ---------------------    -----------
     dburi                    Database URI conforming to `RFC3986`_. SQLite, Postgreql, 
-                             MySQL and MongoDB are currently supported. 
-      
+                             MySQL and MongoDB are currently supported.
+
                              SQLite example: `sqlite:///path/to/your/db`
 
                              Postgreql example: `postgresql://<user>:<pass>@<host[:port]>/<database>`
 
                              MySQL example:     `mysql://<user>:<pass>@<host[:port]>/<database>`
-                 
+
                              MongoDB example:   `mongodb://<user>:<pass>@<host[:port]>/<database>`
     ---------------------    -----------
     **Section**              *Updater*