Extend documentation

Makefile

@@ -59,7 +59,7 @@ docs:
 	sphinx-apidoc -o docs/source/ pwman
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
-	open docs/_build/html/index.html
+	xdg-open docs/build/html/index.html
 
 release: clean
 	python setup.py sdist upload

docs/source/configuration.rst

@@ -51,18 +51,20 @@ Following is a table describing the parameters and their meanings:
     -----------   -----------
     cls_timeout   Number of seconds before the screen is clean after a print.
     -----------   -----------
-    umask         The umask in which database files are written.
+    umask         The umask in which database and configuration files are written.
     -----------   -----------
     xsel          path to the xsel binary (Linux\BSD only) 
     -----------   -----------
     **Section**   *Database* 
     -----------   -----------
-    dburi         Database URI conforming to `RFC3986`_. SQLite, and Postgreql are currently supported. 
+    dburi         Database URI conforming to `RFC3986`_. SQLite, Postgreql and
+                  MySQL are currently supported. 
        
                   SQLite example: `sqlite:///path/to/your/db`
 
-                  Postgreql example: `postgresql://<user>:<pass>@<host>/<database>`
+                  Postgreql example: `postgresql://<user>:<pass>@<host[:port]>/<database>`
 
+                  MySQL example:      `mysql://<user>:<pass>@<host[:port]>/<database>`
     ===========   ===========
 
 

docs/source/index.rst

@@ -14,11 +14,13 @@ Contents:
    install
    tutorial
    configuration  
+   packaging
 
 About pwman3:
 ^^^^^^^^^^^^^ 
 
-Pwman3 is a simple command line password manager for Python 2.7-3.X. 
+Pwman3 is a command line password manager for Python 2.7-3.X with support for 
+multiple databases.
 
 
 

docs/source/packaging.rst

@@ -0,0 +1,35 @@
+Packaging for UNIX\Linux 
+======================== 
+
+Requirements and suggested packages
+-----------------------------------
+The most basic install of pwman requires Python 2.7.x or Python 3.x with 
+SQLite support.
+Some users might be interested in working with a network database such as 
+MySQL or Postgreql, in this case the package should suggest to install but not 
+depend on the following components:
+
+    * `python-psycopg2`_
+    * `python-pymysql`_
+
+.. _python-psycopg2: https://pypi.python.org/pypi/psycopg2 
+.. _python-pymysql: https://pypi.python.org/pypi/PyMySQL
+
+Building a man page
+-------------------
+
+Many users of command line programs expect to find a man page for each and 
+every program installed. Some Linux flavours has even made it a policy (for 
+example `Debian Policy`_). 
+
+If you would like to format a man page for Pwman3, this program provides a 
+helper method for that::
+
+     $ python setup.py build_manpage
+
+This will create a man page `pwman3.1` in the directory where you issued the 
+command. You can control the output by editing the option `output` in the file
+`setup.cfg`.
+
+
+.. _Debian Policy: https://www.debian.org/doc/debian-policy/ch-docs.html