Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)

[privoxy.git] / utils / filter2docs.pl

diff --git a/utils/filter2docs.pl b/utils/filter2docs.pl
new file mode 100755 (executable)
index 0000000..ea326ed
--- /dev/null
+++ b/utils/filter2docs.pl
@@ -0,0 +1,25 @@
+#!/usr/bin/perl -w
+
+# $Id: filter2docs.pl,v 1.1.2.1 2003/03/16 15:32:44 oes Exp $
+# $Source: /cvsroot/ijbswa/current/utils/Attic/filter2docs.pl,v $
+
+# Parse the filter names and descriptions from a filter file and
+# spit out copy&paste-ready markup for the various places in
+# configuration and documentation where all filters are listed.
+
+die "Usage: $0 filter-file\n" unless (@ARGV == 1) ;
+open(INPUT, "< $ARGV[0]") or die "Coudln't open input file $ARGV[0] because $!\n";
+
+while (<INPUT>) {
+  if (/^FILTER: ([-\w]+) (.*)$/) {
+    $comment_lines .= "#     $1:" . (" " x (20-length($1))) . "$2\n";
+    $action_lines  .= "-filter{$1} \\\n";
+    $sgml_source_1 .= "   <para>\n    <anchor id=\"filter-$1\">\n    <screen>+filter{$1}" .
+                      (" " x (20-length($1))) . "# $2</screen>\n   </para>\n";
+    $sgml_source_2 .= " -<link linkend=\"FILTER-" . uc($1) . "\">filter{$1}</link> \\\n";
+  }
+}
+
+print("Comment lines for default.action:\n\n$comment_lines\n\nBlock of filter actions for"
+     ." standard.action:\n\n$action_lines\n\nSGML Source for AF chapter in U-M:" .
+      "\n\n$sgml_source_1\n\nSGML Source for AF Tutorial chapter in U-M\n\n$sgml_source_2\n");