3d6042e5e0daa4fe358034a1816601f8b9634b99
[clawsker.git] / README
1
2 Clawsker - A Claws Mail Tweaker
3 -------------------------------
4
5 Clawsker is a Perl-GTK2 applet to edit hidden preferences for Claws Mail,
6 and to do it in a safe and user friendly way, preventing users from raw 
7 edition of configuration files.
8
9 Claws Mail is a fast and lightweight Mail User Agent by the Claws Mail Team.
10
11 Dependencies
12 ------------
13
14   - Building:
15
16   Nothing special: make, sed, install, gettext and pod2man.
17
18   On Debian systems:
19   # apt-get install make sed coreutils gettext perl
20   (Although you probably already have some of these installed)
21
22   - Running:
23
24   Perl - http://www.perl.com (>= 5.8)
25   GTK+2 bindings for Perl - http://gtk2-perl.sourceforge.net (>= 1.140)
26   Locale::gettext - http://search.cpan.org/~pvandry/gettext-1.05/ (>= 1.05)
27   Claws Mail - http://www.claws-mail.org (>= 3.1.0)
28
29   On Debian systems:
30   # apt-get install libgtk2-perl liblocale-gettext-perl claws-mail
31
32 Install
33 -------
34
35 After downloading the tarball, as root:
36
37   tar xzf clawsker-VERSION.tar.gz
38   cd clawsker-VERSION
39   make
40   make install
41
42 Replace VERSION with the actual version number of the tarball.
43
44 Default install is under /usr/local prefix. If you want to install in another
45 location (for example /usr) replace last line with:
46
47   make install PREFIX=/usr
48
49 Optionally you can provide also a DESTDIR as a root tree for the installation.
50
51 Contributing
52 ------------
53
54 Patches, and specially, new translations (or updates to the existing) are
55 welcome.
56
57 To create a new translation just change to 'po' directory, copy 'clawsker.pot'
58 into 'xx.po' or 'xx_YY.po',  and fill the empty strings and placeholder values. 
59 The 'xx' is your language code (e.g.: 'en' for English, 'fr' for French, etc.)
60 and, optionally, 'YY' defines your country variant (e.g.: 'de_CH' for German
61 variant in Switzerland). Country should be used only if your translation is
62 really specific to that location, otherwise, and specially for new languages,
63 try use the generic language (you can always submit a specific one later).
64
65 Once finished you can test your new translation by adding your 'xx' or 'xx_YY'
66 code to the LINGUAS variable in Makefile and running make. A new .mo file
67 with the same name of your .po file should be created if everything is right.
68
69 To update an existing translation just type 'make xx.pox' or 'make xx_YY.pox'
70 and update the new .pox file created, copy the .pox file to the .po file and
71 test it as above (no need to modify the Makefile this time).
72
73 Thanks
74 ------
75
76 * The Claws Mail Team, for such great mail program
77 * Larry Wall and all Perl hackers all over the world
78 * The Perl-GTK2 folks and Phillip Vandry
79 * Dirk van der Walt, for his Gtk2-Perl Study Guide [0]
80 * Debian, for the Operating System
81
82 [0] http://forgeftp.novell.com//gtk2-perl-study/documentation/html/index.html
83
84 -- 
85 $Id$
86