Document read-only option

[clawsker.git] / clawsker.pod

diff --git a/clawsker.pod b/clawsker.pod
index 87a0bea2d001cac4bb83c358f8e77c8d238caedb..313a6f9eb0d16b958589b50f85bd2a7ae1b64868 100644 (file)
--- a/clawsker.pod
+++ b/clawsker.pod
@@ -1,6 +1,13 @@
 #
 # Clawsker manual page
-# $Id$
+# 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.
 #
 =pod
 
@@ -10,7 +17,7 @@ Clawsker - A Claws Mail Tweaker
 
 =head1 SYNOPSIS
 
-clawsker [options]
+B<clawsker> [options]
 
 =head1 DESCRIPTION
 
@@ -25,36 +32,55 @@ 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
 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.
+
 =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>
 
---version
-       Show information about program, Claws Mail and Perl-GTK versions.
+Uses I<filename> as Claws Mail resource configuration file. This sets
+the full file name overriding any previous setting.
 
---verbose
-       Tells more on the standard output.
+=item B<-h> | B<--help>
 
---alternate-config-dir <dir>
-       Uses <dir> as Claws Mail configuration dir.
+Shows a brief help screen.
 
---clawsrc <file>
-       Uses <file> as Claws Mail resource configuration file. This sets
-       the full file name overriding any previous setting.
+=item B<-r> | B<--read-only>
 
-Multiple options are allowed, although only the last one has effect. Weird
+Allows to edit hidden preferences without saving the changes. It also
+works when Claws Mail is running.
+
+=item B<-v> | B<--version>
+
+Show information about program, Claws Mail and Perl-GTK versions.
+
+=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>"
+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
 
@@ -62,9 +88,11 @@ 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.
 
-=head1 LICENSE
+=head1 COPYRIGHT
+
+2007-2016 by Ricardo Mones Lastra
 
-Copyright (c) 2007-2009 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