[PATCH] Fix documentation for hcache's MD5 generation
Hi,
with the caching patch which made it into CVS yesterday, there was a
paragraph in the manual saying that there's no way to find out which
MD5-based filename is for which folder.
Now, the attached patch fixes it with examples and makes me look like a
fool... (one has to use 'echo -n $folder' instead of 'echo $folder')
As for the others: should there be a need for further tuning, I can push
out my local branch to my public git tree.
Oh, and I hope all 3 manual patches apply cleanly on top of one another
as all diffs are against CVS HEAD's manual.xml.head...
bye, Rocco
--
:wq!
diff --git a/doc/manual.xml.head b/doc/manual.xml.head
index 206960c..cc4d180 100644
--- a/doc/manual.xml.head
+++ b/doc/manual.xml.head
@@ -4520,10 +4520,25 @@ to a directory.
</para>
<para>
-For the one-file-per-folder case, database files will be named by
-MD5 sums and can be removed if a system is short on space. However,
-there currently is no easy to find out which database file is used
-for which folder.
+For the one-file-per-folder case, database files will be named by MD5
+sums and can be removed if a system is short on space. By issuing a
+command like in the following examples, one can find out the MD5-based
+database file name for a folder (<emphasis role="bold">note</emphasis>
+the <literal>-n</literal> option to <literal>echo</literal> command
+as the trailing newline isn't taken into account by mutt when generating
+the checksum):
+</para>
+
+<para>
+<screen>
+$ echo -n '/path/to/folder' | md5sum
+$ echo -n 'imaps://user@host/path/to/folder' | md5sum
+</screen>
+</para>
+
+<para>
+Depending on the system used, the <literal>md5sum</literal> command may
+be named just <literal>md5</literal> (such as FreeBSD, for example).
</para>
</sect2>