From 60f69f82eacd8799f7c52a24934d2e87320bd192 Mon Sep 17 00:00:00 2001
From: simonmar <unknown>
Date: Wed, 5 Oct 2005 12:52:03 +0000
Subject: [haddock @ 2005-10-05 12:52:03 by simonmar] Document new behaviour of
 -s option

---
 doc/haddock.xml | 20 +++++++++++++++++++-
 1 file changed, 19 insertions(+), 1 deletion(-)

(limited to 'doc')

diff --git a/doc/haddock.xml b/doc/haddock.xml
index c027170c..ca49bf38 100644
--- a/doc/haddock.xml
+++ b/doc/haddock.xml
@@ -477,7 +477,25 @@
 	<listitem>
 	  <para>Include links to the source files in the generated
 	  documentation, where <replaceable>URL</replaceable> is the
-	  base URL where the source files can be found.</para>
+	  base URL where the source files can be found.  The following
+	    substitutions are made within the string
+	    <replaceable>URL</replaceable>:</para>
+
+	  <itemizedlist>
+	    <listitem>
+	      <para>The string <literal>%M</literal> is replaced by the module name
+		(with &lsquo;.&rsquo; replaced by &lsquo;/&rsquo;).</para>
+	    </listitem>
+	    <listitem>
+	      <para>The string <literal>%F</literal> is replaced by the
+	      source file name.</para>
+	    </listitem>
+	  </itemizedlist>
+
+	  <para>For example, if your sources are online in a single directory,
+	    you would say <literal>haddock -s
+	      <replaceable>url</replaceable>/%F</literal>.</para>
+
 	</listitem>
       </varlistentry>
 
-- 
cgit v1.2.3