Traditional Chinese translation update by Mark Chang
[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<-i>|B<--ignore-versions>]
16 [B<-r>|B<--read-only>] [B<-u>|B<--use-claws-version> I<version>]
17
18 B<clawsker> [B<-v>|B<--version>]
19
20 B<clawsker> [B<-h>|B<--help>]
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 GTK 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 and all
38 hot key mappings from application menus.
39
40 =head1 OPTIONS
41
42 =over 4
43
44 =item B<-a> | B<--alternate-config-dir> I<dirname>
45
46 Uses I<dirname> as Claws Mail configuration directory.
47
48 =item B<-b> | B<--verbose>
49
50 Tells more on the standard output.
51
52 =item B<-c> | B<--clawsrc> I<filename>
53
54 Uses I<filename> as Claws Mail resource configuration file. This sets
55 the full file name overriding any previous setting.
56
57 =item B<-h> | B<--help>
58
59 Shows a brief help screen.
60
61 =item B<-i> | B<--ignore-versions>
62
63 Ignores any version detected or set by B<-u> option. Almost all options
64 will be available.
65
66 =item B<-r> | B<--read-only>
67
68 Edits hidden preferences without saving the changes. It also works while
69 Claws Mail is running.
70
71 =item B<-u> | B<--use-claws-version> I<version>
72
73 Uses I<version> as Claws Mail version instead of the real one. The
74 I<version> argument is a list of integers, separated by dots if needed.
75
76 =item B<-v> | B<--version>
77
78 Shows version information for program, Perl-GTK and Claws Mail.
79
80 =back
81
82 Weird option specifications may produce weird results (but otherwise correct).
83
84 =head1 LIMITATIONS
85
86 A running Claws Mail cannot be detected if using the B<--clawsrc> option
87 because the directory is not assumed to be a Claws Mail configuration dir.
88 If that is the case use the B<--alternate-config-dir> option instead.
89
90 Detection will also fail if the temporary directory resolution differs.
91 This may happen, for example, when the value of the environment variable
92 B<TMPDIR> under Clawsker is not the same that it was when Claws Mail was
93 launched.
94
95 =head1 SEE ALSO
96
97 L<Clawsker homepage|http://www.claws-mail.org/clawsker.php>,
98 L<List of hidden preferences|http://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden>
99
100 =head1 AUTHOR
101
102 Main author is Ricardo Mones E<lt>ricardo@mones.orgE<gt> with the help of
103 others. See the AUTHORS file on source tarball or git for a detailed list
104 of contributors.
105
106 =head1 COPYRIGHT
107
108 Clawsker is Copyright 2007-2020 by Ricardo Mones Lastra.
109
110 =head1 LICENSE
111
112 This program is free software: you can redistribute it and/or modify
113 it under the terms of the GNU General Public License as published by
114 the Free Software Foundation, either version 3 of the License, or
115 (at your option) any later version.
116
117 This program is distributed in the hope that it will be useful,
118 but WITHOUT ANY WARRANTY; without even the implied warranty of
119 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
120 GNU General Public License for more details.
121
122 You should have received a copy of the GNU General Public License
123 along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
124
125 =cut
126