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