update i18n
[clawsker.git] / clawsker.pod
1 #
2 # Clawsker manual page
3 # $Id$
4 #
5 =pod
6
7 =head1 NAME
8
9 Clawsker - A Claws Mail Tweaker
10
11 =head1 SYNOPSIS
12
13 clawsker [options]
14
15 =head1 DESCRIPTION
16
17 Clawsker is an applet to edit the so called Claws Mail hidden preferences.
18
19 Claws Mail is a fast, lightweight and feature-rich MUA with a high number 
20 of configurable options. To keep the binary small and fast some of these 
21 preferences which are not widely used are not provided with a graphical
22 interface for inspection and/or modification.
23
24 Users wanting to edit such preferences had to face raw editing of their 
25 configuration files, now you can do it with a convenient GTK2 interface
26 using Clawsker.
27
28 In adition to hidden features Clawsker can edit also some other settings
29 which usually can only be set indirectly. These include currently the
30 saved positions (and sizes when available) of Claws Mail windows.
31
32 =head1 OPTIONS
33
34 --help
35         Shows a brief help screen.
36
37 --version
38         Show information about program, Claws Mail and Perl-GTK versions.
39
40 --verbose
41         Tells more on the standard output.
42
43 --alternate-config-dir <dir>
44         Uses <dir> as Claws Mail configuration dir.
45
46 --clawsrc <file>
47         Uses <file> as Claws Mail resource configuration file. This sets
48         the full file name overriding any previous setting.
49
50 Multiple options are allowed, although only the last one has effect. Weird
51 option specifications may produce weird results (but otherwise correct).
52         
53 =head1 LIMITATIONS
54
55 A running Claws Mail cannot be detected if using the --clawsrc option because
56 the directory is not assumed to be a Claws Mail configuration dir. If that is 
57 the case use the --alternate-config-dir option instead.
58
59 =head1 SEE ALSO
60
61 Clawsker homepage "L<http://www.claws-mail.org/clawsker>"
62 Hidden preferences list "L<http://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden>"
63
64 =head1 AUTHOR
65
66 Main author is Ricardo Mones E<lt>ricardo@mones.orgE<gt> with the help of
67 others. See the AUTHORS file on source tarball for a detailed list of 
68 contributors.
69
70 =head1 LICENSE
71
72 Copyright (c) 2007-2010 by Ricardo Mones Lastra
73
74 This program is free software: you can redistribute it and/or modify
75 it under the terms of the GNU General Public License as published by
76 the Free Software Foundation, either version 3 of the License, or
77 (at your option) any later version.
78
79 This program is distributed in the hope that it will be useful,
80 but WITHOUT ANY WARRANTY; without even the implied warranty of
81 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
82 GNU General Public License for more details.
83
84 You should have received a copy of the GNU General Public License
85 along with this program.  If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
86
87 =cut
88