Debian Codegraph @

docs/source/packaging.rst

raw
1 Packaging for UNIX\\Linux
2 =========================
3
4 Requirements and suggested packages
5 -----------------------------------
6 The most basic install of pwman requires Python 2.7.x or Python 3.x with
7 SQLite support.
8 Some users might be interested in working with a network database such as
9 MySQL or Postgreql, in this case the package should suggest to install but not
10 depend on the following components:
11
12 * `python-psycopg2`_
13 * `python-pymysql`_
14
15 .. _python-psycopg2: https://pypi.python.org/pypi/psycopg2
16 .. _python-pymysql: https://pypi.python.org/pypi/PyMySQL
17
18 Building a man page
19 -------------------
20
21 Many users of command line programs expect to find a man page for each and
22 every program installed. Some Linux flavours has even made it a policy (for
23 example `Debian Policy`_).
24
25 If you would like to format a man page for Pwman3, this program provides a
26 helper method for that::
27
28 $ python setup.py build_manpage
29
30 This will create a man page `pwman3.1` in the directory where you issued the
31 command. You can control the output by editing the option `output` in the file
32 `setup.cfg`.
33
34
35 .. _Debian Policy: https://www.debian.org/doc/debian-policy/ch-docs.html