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