link-checker commit: --masquerade doc improvements, thanks to C. M. Sperberg-McQueen.

changeset:   314:051747f1fdff
user:        ville
date:        Tue Apr 28 20:33:44 2009 +0000
files:       bin/checklink.pod
description:
--masquerade doc improvements, thanks to C. M. Sperberg-McQueen.


diff -r 8ee6b3e8323b -r 051747f1fdff bin/checklink.pod
--- a/bin/checklink.pod	Tue Apr 28 20:17:19 2009 +0000
+++ b/bin/checklink.pod	Tue Apr 28 20:33:44 2009 +0000
@@ -1,4 +1,4 @@
-$Id: checklink.pod,v 1.23 2009-04-28 20:17:19 ville Exp $
+$Id: checklink.pod,v 1.24 2009-04-28 20:33:44 ville Exp $
 
 =head1 NAME
 
@@ -132,12 +132,18 @@
 in the configuration file.  See the C<Trusted> entry in the configuration
 file description below for more information.
 
-=item B<--masquerade> I<"local remote">
+=item B<--masquerade> I<"surrogate-prefix real-prefix">
 
-Masquerade local dir as a remote URI.  For example, the following results in
-/my/local/dir/ being "mapped" to http://some/remote/uri/
+Perform a simple string substitution: URIs which begin with the
+string C<real-prefix> are rewritten using the C<surrogate-prefix>
+before being dereferenced.  Useful for making a local
+directory masquerade as a remote one. For example:
 
-  --masquerade "/my/local/dir http://some/remote/uri/"
+  --masquerade "file:///my/local/dir/ http://example.com/x/y/z/"
+
+If the document being checked contains a link to
+http://example.com/x/y/z/foo.html, then the local file system will be
+checked for file:///my/local/dir/foo.html.
 
 B<--masquerade> takes a single argument consisting of two URIs,
 separated by whitespace.  The quote marks are not part of the

Received on Thursday, 5 August 2010 14:47:32 UTC