summaryrefslogtreecommitdiffstats
path: root/README
blob: 608ea7d3a6c2ec0f9901ddba9fe953b9a238a6a0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
WhisperBack - Send feedback via encrypted e-mail
################################################

Copyright (C) 2009-2012 Tails developers <tails@boum.org>

DESCRIPTION
===========

WhisperBack is a small pyGTK application intended to provide
a user-friendly way to send feedback to the amnesia dev team in
a GnuPG-encrypted way.


DEPENDENCIES
============

You need the following runtime dependencies:
  - python-gtk2
  - python-pyme

In addition, you need the following build dependencies:
  - python-distutils-extra
  - txt2tags


INSTALLATION
============

WhisperBack is packaged using Python distutils. To install it:

  $ ./setup.py build

and as root:

  # ./setup.py install


CONFIGURATION
=============

The configuration is read in sequence from the following files,
settings read last overriding previous ones:
- /etc/whisperback/config.py
- ~/.whisperback/config.py
- ./config.py

The config.py.sample example configuration file will tell you about the
configuration syntax and available settings.


USAGE
=====

Please see the man page.


LICENSING
=========

This file is part of WhisperBack.

WhisperBack is  free software; you can redistribute  it and/or modify
it under the  terms of the GNU General Public  License as published by
the Free Software Foundation; either  version 3 of the License, or (at
your option) any later version.

This program  is distributed in the  hope that it will  be useful, but
WITHOUT   ANY  WARRANTY;   without  even   the  implied   warranty  of
MERCHANTABILITY  or FITNESS  FOR A  PARTICULAR PURPOSE.   See  the GNU
General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.

Please see COPYING for more information.