clawsker.pod

   1 #
   2 # Clawsker manual page
   3 # Copyright 2007-2015 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<-h> | B<--help>
  44
  45 Shows a brief help screen.
  46
  47 =item B<-v> | B<--version>
  48
  49 Show information about program, Claws Mail and Perl-GTK versions.
  50
  51 =item B<-b> | B<--verbose>
  52
  53 Tells more on the standard output.
  54
  55 =item B<-a> | B<--alternate-config-dir> I<dirname>
  56
  57 Uses I<dirname> as Claws Mail configuration directory.
  58
  59 =item B<-c> | B<--clawsrc> I<filename>
  60
  61 Uses I<filename> as Claws Mail resource configuration file. This sets
  62 the full file name overriding any previous setting.
  63
  64 =back
  65
  66 Repeated options are allowed, although only the last one has effect. Weird
  67 option specifications may produce weird results (but otherwise correct).
  68
  69 =head1 LIMITATIONS
  70
  71 A running Claws Mail cannot be detected if using the B<--clawsrc> option
  72 because the directory is not assumed to be a Claws Mail configuration dir.
  73 If that is  the case use the B<--alternate-config-dir> option instead.
  74
  75 =head1 SEE ALSO
  76
  77 L<Clawsker homepage|http://www.claws-mail.org/clawsker.php>,
  78 L<List of hidden preferences|http://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden>
  79
  80 =head1 AUTHOR
  81
  82 Main author is Ricardo Mones E<lt>ricardo@mones.orgE<gt> with the help of
  83 others. See the AUTHORS file on source tarball for a detailed list of
  84 contributors.
  85
  86 =head1 COPYRIGHT
  87
  88 2007-2015 by Ricardo Mones Lastra
  89
  90 =head1 LICENSE
  91
  92 This program is free software: you can redistribute it and/or modify
  93 it under the terms of the GNU General Public License as published by
  94 the Free Software Foundation, either version 3 of the License, or
  95 (at your option) any later version.
  96
  97 This program is distributed in the hope that it will be useful,
  98 but WITHOUT ANY WARRANTY; without even the implied warranty of
  99 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 100 GNU General Public License for more details.
 101
 102 You should have received a copy of the GNU General Public License
 103 along with this program.  If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
 104
 105 =cut
 106