Update year
[clawsker.git] / clawsker.pod
1 #
2 # Clawsker manual page
3 #
4 # See COPYRIGHT and LICENSE sections below and COPYING file for details.
5 #
6 =pod
7
8 =head1 NAME
9
10 Clawsker - A Claws Mail Tweaker
11
12 =head1 SYNOPSIS
13
14 B<clawsker> [B<-a>|B<--alternate-config-dir> I<dirname>] [B<-b>|B<--verbose>]
15 [B<-c>|B<--clawsrc> I<filename>] [B<-r>|B<--read-only>]
16
17 B<clawsker> [B<-v>|B<--version>]
18
19 B<clawsker> [B<-h>|B<--help>]
20
21 =head1 DESCRIPTION
22
23 Clawsker is an applet to edit the so called Claws Mail hidden preferences.
24
25 Claws Mail is a fast, lightweight and feature-rich MUA with a high number 
26 of configurable options. To keep the binary small and fast some of these 
27 preferences which are not widely used are not provided with a graphical
28 interface for inspection and/or modification.
29
30 Users wanting to edit such preferences had to face raw editing of their 
31 configuration files, now you can do it with a convenient GTK interface
32 using Clawsker.
33
34 In adition to hidden features Clawsker can edit also some other settings
35 which usually can only be set indirectly. These include currently the
36 saved positions (and sizes when available) of Claws Mail windows.
37
38 =head1 OPTIONS
39
40 =over 4
41
42 =item B<-a> | B<--alternate-config-dir> I<dirname>
43
44 Uses I<dirname> as Claws Mail configuration directory.
45
46 =item B<-b> | B<--verbose>
47
48 Tells more on the standard output.
49
50 =item B<-c> | B<--clawsrc> I<filename>
51
52 Uses I<filename> as Claws Mail resource configuration file. This sets
53 the full file name overriding any previous setting.
54
55 =item B<-h> | B<--help>
56
57 Shows a brief help screen.
58
59 =item B<-r> | B<--read-only>
60
61 Edits hidden preferences without saving the changes. It also works while
62 Claws Mail is running.
63
64 =item B<-v> | B<--version>
65
66 Shows version information for program, Perl-GTK and Claws Mail.
67
68 =back
69
70 Weird option specifications may produce weird results (but otherwise correct).
71
72 =head1 LIMITATIONS
73
74 A running Claws Mail cannot be detected if using the B<--clawsrc> option
75 because the directory is not assumed to be a Claws Mail configuration dir.
76 If that is the case use the B<--alternate-config-dir> option instead.
77
78 Detection will also fail if the temporary directory resolution differs.
79 This may happen, for example, when the value of the environment variable
80 B<TMPDIR> under Clawsker is not the same that it was when Claws Mail was
81 launched.
82
83 =head1 SEE ALSO
84
85 L<Clawsker homepage|http://www.claws-mail.org/clawsker.php>,
86 L<List of hidden preferences|http://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden>
87
88 =head1 AUTHOR
89
90 Main author is Ricardo Mones E<lt>ricardo@mones.orgE<gt> with the help of
91 others. See the AUTHORS file on source tarball or git for a detailed list
92 of contributors.
93
94 =head1 COPYRIGHT
95
96 Clawsker is Copyright 2007-2019 by Ricardo Mones Lastra.
97
98 =head1 LICENSE
99
100 This program is free software: you can redistribute it and/or modify
101 it under the terms of the GNU General Public License as published by
102 the Free Software Foundation, either version 3 of the License, or
103 (at your option) any later version.
104
105 This program is distributed in the hope that it will be useful,
106 but WITHOUT ANY WARRANTY; without even the implied warranty of
107 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
108 GNU General Public License for more details.
109
110 You should have received a copy of the GNU General Public License
111 along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
112
113 =cut
114