pwman3/docs/source/configuration.rst

Configuring Pwman3
==================

By default Pwman3 will read the configuration file from the following path on Unix like systems::

    ~/.config/pwman/config

On windows the configuration is found in ``%APPDATA/pwman/%``

You can override this by giving the ``-c <Config File>`` at the commnad line
when starting Pwman3.

The configuration file has the following structure::

    [Section]
    Option = Value

The following is an example default config file::

    [Readline]
    history = <PWMAN_DATA_DIR>/history

    [Global]
    save = True
    colors = yes
    cp_timeout = 5
    umask = 0100
    cls_timeout = 10
    xsel = /usr/bin/xsel
    lock_timeout = 60

    [Database]
    filename = sqlite:///<PWMAN_DATA_DIR>/pwman.db`

    [Updater]
    supress_version_check = no
    client_info = ee5cd64310568736b971e3fb7c7064a4459b99a2b78672515fd0f06c82f65d5

On Windows ``PWMAN_DATA_DIR`` is ``%APPDATA/pwman/%`` on Unix like systems it is
``~/.local/share/pwman/``.

Following is a table describing the parameters and their meanings:


    =====================    ===========
    **Section**              *Readline*
    ---------------------    -----------
                             *Global*
    history                  path to the file containing history of commands typed
    ---------------------    -----------
    **Section**              *Global*
    ---------------------    -----------
    save                     True or False - whether the Configuring file should be saved
    ---------------------    -----------
    colors                   yes or no - If set to *no*, no colors used in output. This is useful for breil terminals. 
    ---------------------    -----------
    cp_timeout               Number of seconds before the clipboard is erased.
    ---------------------    -----------
    cls_timeout              Number of seconds before the screen is clean after a print. Set to 0 to disable.
    ---------------------    -----------
    umask                    The umask in which database and configuration files are written.
    ---------------------    -----------
    xsel                     path to the xsel binary (Linux\BSD only).
    ---------------------    -----------
    lock_timeout             set the period (in secods) after which the database is locked.
    ---------------------    -----------
    **Section**              *Database*
    ---------------------    -----------
    dburi                    Database URI conforming to `RFC3986`_. SQLite, Postgreql, 
                             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*
    ---------------------    -----------
    supress_version_check    yes or no - check for newer versions of pwman3
    ---------------------    -----------
    client_info              sha256 digest of host name and username, used for identifying the client
    =====================    ===========


.. _RFC3986: http://www.ietf.org/rfc/rfc3986.txt