#
# Clawsker manual page
-# Copyright 2007-2016 Ricardo Mones <ricardo@mones.org>
#
-# This program is free software: you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-#
-# See COPYING file for license details.
+# See COPYRIGHT and LICENSE sections below and COPYING file for details.
#
=pod
=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
=over 4
+=item B<-a> | B<--alternate-config-dir> I<dirname>
+
+Uses I<dirname> as Claws Mail configuration directory.
+
+=item B<-b> | B<--verbose>
+
+Tells more on the standard output.
+
+=item B<-c> | B<--clawsrc> I<filename>
+
+Uses I<filename> as Claws Mail resource configuration file. This sets
+the full file name overriding any previous setting.
+
=item B<-h> | B<--help>
Shows a brief help screen.
-=item B<-v> | B<--version>
+=item B<-i> | B<--ignore-versions>
-Show information about program, Claws Mail and Perl-GTK versions.
+Ignores any version detected or set by B<-u> option. Almost all options
+will be available.
-=item B<-b> | B<--verbose>
+=item B<-k> | B<--hide-disabled-keys>
-Tells more on the standard output.
+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<-a> | B<--alternate-config-dir> I<dirname>
+=item B<-r> | B<--read-only>
-Uses I<dirname> as Claws Mail configuration directory.
+Edits hidden preferences without saving the changes. It also works while
+Claws Mail is running.
-=item B<-c> | B<--clawsrc> I<filename>
+=item B<-s> | B<--small-screen>
-Uses I<filename> as Claws Mail resource configuration file. This sets
-the full file name overriding any previous setting.
+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 AUTHOR
Main author is Ricardo Mones E<lt>ricardo@mones.orgE<gt> with the help of
-others. See the AUTHORS file on source tarball for a detailed list of
-contributors.
+others. See the AUTHORS file on source tarball or git for a detailed list
+of contributors.
=head1 COPYRIGHT
-2007-2016 by Ricardo Mones Lastra
+Clawsker is Copyright 2007-2023 by Ricardo Mones Lastra.
=head1 LICENSE
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
-along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
+along with this program. If not, see E<lt>http://www.gnu.org/licenses/E<gt>.
=cut
projects / clawsker.git / blobdiff