Document read-only option
[clawsker.git] / clawsker.pod
index d99f5e2d50ddcf02de0ada55c7d9cb3a933396fd..313a6f9eb0d16b958589b50f85bd2a7ae1b64868 100644 (file)
@@ -1,6 +1,6 @@
 #
 # Clawsker manual page
-# Copyright 2007-2014 Ricardo Mones <ricardo@mones.org>
+# 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
@@ -40,26 +40,31 @@ saved positions (and sizes when available) of Claws Mail windows.
 
 =over 4
 
-=item B<--help>
+=item B<-a> | B<--alternate-config-dir> I<dirname>
 
-Shows a brief help screen.
+Uses I<dirname> as Claws Mail configuration directory.
 
-=item B<--version>
+=item B<-b> | B<--verbose>
 
-Show information about program, Claws Mail and Perl-GTK versions.
+Tells more on the standard output.
 
-=item B<--verbose>
+=item B<-c> | B<--clawsrc> I<filename>
 
-Tells more on the standard output.
+Uses I<filename> as Claws Mail resource configuration file. This sets
+the full file name overriding any previous setting.
 
-=item B<--alternate-config-dir> I<dirname>
+=item B<-h> | B<--help>
 
-Uses I<dirname> as Claws Mail configuration directory.
+Shows a brief help screen.
 
-=item B<--clawsrc> I<filename>
+=item B<-r> | B<--read-only>
 
-Uses I<filename> as Claws Mail resource configuration file. This sets
-the full file name overriding any previous setting.
+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
 
@@ -85,7 +90,7 @@ contributors.
 
 =head1 COPYRIGHT
 
-2007-2014 by Ricardo Mones Lastra
+2007-2016 by Ricardo Mones Lastra
 
 =head1 LICENSE