update copyright year
[claws.git] / INSTALL
1 Installation
2 ============
3
4 This program requires GTK 3.20 or higher to be compiled.
5
6 Build it
7 ========
8
9 If you're using a package-based system, please make sure that gtk-devel
10 and glib-devel (or similar) packages are installed before the compilation
11 (you may also require flex (lex),  and bison (yacc)).
12
13 To compile and install, just type:
14
15 % ./configure
16 % make
17 % su
18 Password: [Enter password]
19 # make install
20
21 To run, just type:
22
23 % claws-mail
24
25
26 Additional libraries or programs
27 ================================
28 only needed if you require the additional functionality
29
30 Bogofilter
31     for Bogofilter plugin support
32     https://www.bogofilter.org/
33 Bsfilter
34     for Bsfilter plugin support
35     https://osdn.net/projects/bsfilter/
36 Canberra (>= 0.6)
37     for some sound features of Notification plugin
38     https://0pointer.de/lennart/projects/libcanberra/
39 compface
40     for X-Face support
41     https://freshmeat.net/projects/compface/
42 Clam AntiVirus daemon
43     for Clamd plugin support
44     https://www.clamav.net/
45 D-Bus (>= 0.60)
46     for interprocess communication support
47     https://www.freedesktop.org/wiki/Software/dbus
48 Enchant (and dictionaries) (>= 1.0.0)
49     for spell-checker support
50     https://abiword.github.io/enchant/
51 GnuPG (>= 1.2.1) and GPGME (>=  0.4.5)
52     for GnuPG and S/MIME plugin support
53     https://www.gnupg.org/
54     https://www.gnupg.org/software/gpgme/
55 GnuTLS (>= 0.4.2)
56     for SSL support
57     https://gnutls.org/
58 GTK WebKit (>= 2.0)
59     for Fancy plugin support
60     https://trac.webkit.org/wiki/WebKitGTK/
61 Gs tool
62     for PostScript feature of PDF Viewer plugin
63     https://pages.cs.wisc.edu/~ghost/
64 Indicate (>= 0.3.0)
65     for indicator feature of Notification plugin
66     https://launchpad.net/libindicator/
67 J-Pilot
68     for J-Pilot support
69     https://www.jpilot.org/
70 LCDproc daemon
71     for lcdproc feature of Notification plugin
72     https://www.lcdproc.org
73 libEtPan! (>= 0.57)
74     for IMAP4, NNTP and Mailmbox plugin support
75     https://www.etpan.org
76 Network Manager (>= 0.6.2)
77     for support for detection of network connection changes
78     https://www.gnome.org/projects/NetworkManager/
79 OpenLDAP (>= 2.0.7)
80     for LDAP support
81     https://www.openldap.org/
82 Perl (>= 5.8.0)
83     for perl plugin support
84     https://www.perl.org/
85 Poppler (>= 0.4.2)
86     for PDF Viewer plugin support
87     https://poppler.freedesktop.org/
88 PyGObject (>= 3.0.0) 
89     for Python plugin support
90     https://pygobject.readthedocs.io/
91 Python
92     for Python plugin support
93     https://python.org/
94 SpamAssassin
95     for SpamAssassin plugin support
96     https://spamassassin.apache.org/
97
98
99 Options for configure script
100 ============================
101 For list of available options, refer to "./configure --help".
102
103 Most options are automatically enabled if the dependencies
104 are matched.
105
106