Fix edit field not disabled at startup if corresponding checkbox (and option)
[clawsker.git] / clawsker.pod
index bd10d9021343d9bb2b99953db2c2bebd499a63fa..f685ff03bf8e2709edde3ac347b3afe7c12bedaf 100644 (file)
@@ -1,6 +1,8 @@
 #
 # Clawsker manual page
 #
+# See COPYRIGHT and LICENSE sections below and COPYING file for details.
+#
 =pod
 
 =head1 NAME
@@ -9,7 +11,7 @@ Clawsker - A Claws Mail Tweaker
 
 =head1 SYNOPSIS
 
-clawsker [options]
+B<clawsker> [options]
 
 =head1 DESCRIPTION
 
@@ -30,45 +32,61 @@ saved positions (and sizes when available) of Claws Mail windows.
 
 =head1 OPTIONS
 
---help
-       Shows a brief help screen.
+=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.
 
---version
-       Show information about program, Claws Mail and Perl-GTK versions.
+=item B<-h> | B<--help>
 
---verbose
-       Tells more on the standard output.
+Shows a brief help screen.
 
---alternate-config-dir <dir>
-       Uses <dir> as Claws Mail configuration dir.
+=item B<-r> | B<--read-only>
 
---clawsrc <file>
-       Uses <file> as Claws Mail resource configuration file. This sets
-       the full file name overriding any previous setting.
+Edits hidden preferences without saving the changes. It also works while
+Claws Mail is running.
 
-Multiple options are allowed, although only the last one has effect. Weird
+=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).
        
 =head1 LIMITATIONS
 
-A running Claws Mail cannot be detected if using the --clawsrc option because
-the directory is not assumed to be a Claws Mail configuration dir. If that is 
-the case use the --alternate-config-dir option instead.
+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.
 
 =head1 SEE ALSO
 
-Clawsker homepage "L<http://www.claws-mail.org/clawsker>"
-Hidden preferences list "L<http://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden>"
+L<Clawsker homepage|http://www.claws-mail.org/clawsker.php>,
+L<List of hidden preferences|http://www.claws-mail.org/manual/claws-mail-manual.html#adv_hidden>
 
 =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 LICENSE
+=head1 COPYRIGHT
+
+Clawsker is Copyright 2007-2016 by Ricardo Mones Lastra.
 
-Copyright (c) 2007-2013 by Ricardo Mones Lastra
+=head1 LICENSE
 
 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
@@ -77,11 +95,11 @@ the Free Software Foundation, either version 3 of the License, or
 
 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