INN commit: trunk/doc/pod (grephistory.pod)

[INN Commit]

    Date: Wednesday, August 19, 2009 @ 01:00:26
  Author: iulius
Revision: 8581

Add examples in grephistory documentation.

Modified:
  trunk/doc/pod/grephistory.pod

-----------------+
 grephistory.pod |   34 +++++++++++++++++++++++++++++++++-
 1 file changed, 33 insertions(+), 1 deletion(-)

Modified: grephistory.pod
===================================================================
--- grephistory.pod	2009-08-18 20:19:00 UTC (rev 8580)
+++ grephistory.pod	2009-08-19 08:00:26 UTC (rev 8581)
@@ -75,6 +75,38 @@
 
 =back
 
+=head1 EXAMPLES
+
+In case the requested article is not listed in the history database:
+
+    % grephistory '<unknown.article at news.example.com>'
+    grephistory: not found
+    % grephistory -v '<unknown.article at news.example.com>'
+    grephistory: not found (hash is 501C66C22932BA91131186D7218201EB)
+
+In case the requested article is listed in the history database
+but not stored on the server:
+
+    % grephistory '<remembered.article at news.example.com>'
+    /dev/null
+
+In case the requested article is stored on the server:
+
+    % grephistory '<87fxeaay1z.fsf at windlord.stanford.edu>'
+    @02014A2DD6231FCC00000000000000000000@
+    % grephistory -l '<87fxeaay1z.fsf at windlord.stanford.edu>'
+    [B6DDF69376E3CC199246CEC949B3ACAC]  1244517923~-~1244517912  @02014A2DD6231FCC00000000000000000000@
+
+With B<sm>, we can retrieve the article, and get its posting date:
+
+    % grephistory '<87fxeaay1z.fsf at windlord.stanford.edu>' | sm | grep Date
+    Date: Mon, 08 Jun 2009 20:25:12 -0700
+
+    % convdate -dc 1244517912
+    Tue, 9 Jun 2009 03:25:12 +0000 (UTC)
+
+It matches the number recorded in history as for its posting date.
+
 =head1 HISTORY
 
 Written by Rich $alz <rsalz at uunet.uu.net> for InterNetNews.  Rewritten in
@@ -84,6 +116,6 @@
 
 =head1 SEE ALSO
 
-history(5), inn.conf(5).
+history(5), inn.conf(5), sm(1).
 
 =cut