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