=head1 SYNOPSIS
-B<clawsker> [options]
+B<clawsker> [B<-a>|B<--alternate-config-dir> I<dirname>] [B<-b>|B<--verbose>]
+[B<-c>|B<--clawsrc> I<filename>] [B<-i>|B<--ignore-versions>]
+[B<-k>|B<--hide-disabled-keys>] [B<-r>|B<--read-only>]
+[B<-s>|B<--small-screen>] [B<-u>|B<--use-claws-version> I<version>]
+
+B<clawsker> [B<-v>|B<--version>]
+
+B<clawsker> [B<-h>|B<--help>]
=head1 DESCRIPTION
Clawsker is an applet to edit the so called Claws Mail hidden preferences.
-Claws Mail is a fast, lightweight and feature-rich MUA with a high number
-of configurable options. To keep the binary small and fast some of these
+Claws Mail is a fast, lightweight and feature-rich MUA with a high number
+of configurable options. To keep the binary small and fast some of these
preferences which are not widely used are not provided with a graphical
interface for inspection and/or modification.
-Users wanting to edit such preferences had to face raw editing of their
-configuration files, now you can do it with a convenient GTK2 interface
+Users wanting to edit such preferences had to face raw editing of their
+configuration files, now you can do it with a convenient GTK interface
using Clawsker.
In adition to hidden features Clawsker can edit also some other settings
which usually can only be set indirectly. These include currently the
-saved positions (and sizes when available) of Claws Mail windows.
+saved positions (and sizes when available) of Claws Mail windows and all
+hot key mappings from application menus.
=head1 OPTIONS
Shows a brief help screen.
+=item B<-i> | B<--ignore-versions>
+
+Ignores any version detected or set by B<-u> option. Almost all options
+will be available.
+
+=item B<-k> | B<--hide-disabled-keys>
+
+On hotkeys columns sets foreground colour of unassigned keys to the same
+colour used as background, rendering them invisible until selected. This
+may help locating assigned keys on very long lists.
+
=item B<-r> | B<--read-only>
Edits hidden preferences without saving the changes. It also works while
Claws Mail is running.
+=item B<-s> | B<--small-screen>
+
+Resolution of display is autodetected to adjust UI for screens where
+default rendering would exceed available space. This option forces those
+small screen adjustments. This can be useful for screens where the UI
+fits resolution, but the screen state is already used by other programs.
+
+=item B<-u> | B<--use-claws-version> I<version>
+
+Uses I<version> as Claws Mail version instead of the real one. The
+I<version> argument is a list of integers, separated by dots if needed.
+
=item B<-v> | B<--version>
Shows version information for program, Perl-GTK and Claws Mail.
=back
-Repeated options are allowed, although only the last one has effect. Weird
-option specifications may produce weird results (but otherwise correct).
-
+Weird option specifications may produce weird results (but otherwise correct).
+
=head1 LIMITATIONS
-A running Claws Mail cannot be detected if using the B<--clawsrc> option
-because the directory is not assumed to be a Claws Mail configuration dir.
-If that is the case use the B<--alternate-config-dir> option instead.
+A running Claws Mail cannot be detected when using the B<--clawsrc>
+option because the directory containing the given file is not expected
+to be a full Claws Mail configuration folder. If that is the case use
+the B<--alternate-config-dir> option instead.
+
+Detection will also fail if the temporary directory resolution differs.
+This may happen, for example, when the value of the environment variable
+B<TMPDIR>, under Clawsker is not the same that it was when Claws Mail
+was launched. For Claws Mail versions greater than 3.17.8 different
+values for B<XDG_RUNTIME_DIR> or B<XDG_CACHE_HOME> may also cause this.
+
+=head1 BUGS
+
+You can send bug reports using the Claws Mail bugzilla instance located
+at L<http://www.thewildbeast.co.uk/claws-mail/bugzilla/>. When creating
+the bug please select the C<clawsker> product.
+
+Security bugs can be reported also in bugzilla or to the main author
+directly if a coordinated disclosure is preferable.
=head1 SEE ALSO
=head1 COPYRIGHT
-Clawsker is Copyright 2007-2016 by Ricardo Mones Lastra.
+Clawsker is Copyright 2007-2023 by Ricardo Mones Lastra.
=head1 LICENSE
projects / clawsker.git / blobdiff