url_lfs_rewrite: Update man(8) documentation

diff --git a/helpers/storeid_rewrite/file/storeid_file_rewrite.pl.in b/helpers/storeid_rewrite/file/storeid_file_rewrite.pl.in
index 4deb6318869994e8c19a570d0e0d8bd1a718ef76..f819f23571294a4c9579590a47396ef89d8936e6 100644 (file)
--- a/helpers/storeid_rewrite/file/storeid_file_rewrite.pl.in
+++ b/helpers/storeid_rewrite/file/storeid_file_rewrite.pl.in
@@ -1,17 +1,18 @@
 #!@PERL@
+
 use strict;
 use warnings;
-$|=1;
+use Pod::Usage;
 
 =pod
 
 =head1 NAME
 
-storeid_file_rewrite - File based Store-ID helper for Squid
+ storeid_file_rewrite - File based Store-ID helper for Squid
 
 =head1 SYNOPSIS
 
-storeid_file_rewrite filepath
+ storeid_file_rewrite filepath
 
 =head1 DESCRIPTION
 
@@ -31,7 +32,63 @@ So for best performance, sort it in order of frequency of occurrence.
 This program will automatically detect the existence of a concurrecy channel-ID and adjust appropriately.
 It may be used with any value 0 or above for the store_id_children concurrency= parameter.
 
-For more information please see http://wiki.squid-cache.org/Features/StoreID
+=head1 OPTIONS
+
+The only command line parameter this helper takes is the regex rules file name.
+
+=head1 AUTHOR
+
+This program and documentation was written by I<Alan Mizrahi <alan@mizrahi.com.ve>>
+
+Based on prior work by I<Eliezer Croitoru <eliezer@ngtech.co.il>>
+
+=head1 COPYRIGHT
+
+ * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
+ *
+ * Squid software is distributed under GPLv2+ license and includes
+ * contributions from numerous individuals and organizations.
+ * Please see the COPYING and CONTRIBUTORS files for details.
+
+ Copyright (C) 2013 Alan Mizrahi <alan@mizrahi.com.ve>
+ Based on code from Eliezer Croitoru <eliezer@ngtech.co.il>
+
+ This program is free software; you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation; either version 2 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program; if not, write to the Free Software
+ Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
+
+=head1 QUESTIONS
+
+Questions on the usage of this program can be sent to the I<Squid Users mailing list <squid-users@squid-cache.org>>
+
+=head1 REPORTING BUGS
+
+Bug reports need to be made in English.
+See http://wiki.squid-cache.org/SquidFaq/BugReporting for details of what you need to include with your bug report.
+
+Report bugs or bug fixes using http://bugs.squid-cache.org/
+
+Report serious security bugs to I<Squid Bugs <squid-bugs@squid-cache.org>>
+
+Report ideas for new improvements to the I<Squid Developers mailing list <squid-dev@squid-cache.org>>
+
+=head1 SEE ALSO
+
+squid (8), GPL (7),
+
+The Squid wiki http://wiki.squid-cache.org/Features/StoreID
+
+The Squid Configuration Manual http://www.squid-cache.org/Doc/config/
 
 =cut
 
@@ -52,6 +109,7 @@ while (<RULES>) {
 }
 close RULES;
 
+$|=1;
 # read urls from squid and do the replacement
 URL: while (<STDIN>) {
        chomp;
@@ -75,32 +133,3 @@ URL: while (<STDIN>) {
        }
        print $channel, "ERR\n";
 }
-
-=pod
-
-=head1 COPYRIGHT
-
- * Copyright (C) 1996-2014 The Squid Software Foundation and contributors
- *
- * Squid software is distributed under GPLv2+ license and includes
- * contributions from numerous individuals and organizations.
- * Please see the COPYING and CONTRIBUTORS files for details.
-
-Copyright (C) 2013 Alan Mizrahi <alan@mizrahi.com.ve>
-Based on code from Eliezer Croitoru <eliezer@ngtech.co.il>
-
-This program is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-This program is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with this program; if not, write to the Free Software
-Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307, USA.
-
-=cut

diff --git a/helpers/url_rewrite/LFS/url_lfs_rewrite.pl.in b/helpers/url_rewrite/LFS/url_lfs_rewrite.pl.in
index a2b7e73520281feafac7997c561cb1978cea91ea..f96e205ac0f0227ce721506c3f8dba3b411a20d3 100755 (executable)
--- a/helpers/url_rewrite/LFS/url_lfs_rewrite.pl.in
+++ b/helpers/url_rewrite/LFS/url_lfs_rewrite.pl.in
@@ -1,5 +1,9 @@
 #!@PERL@
 
+use strict;
+use Getopt::Long;
+use Pod::Usage;
+
 =pod
 
 =head1 NAME
@@ -23,7 +27,7 @@ This program uses Squid concurrency support.
 
 =item B<--debug>
 
-Display debug output.
+Write debug info to stderr.
 
 =item B<--local-dir>
 
@@ -33,13 +37,13 @@ Directory path under which the scripts searches for files.
 
 Scheme to use for the redirected URL.
 
-Default: http
+ Default: http
 
 =item B<--to-host>
 
 Domain name to use for the redirected URL.
 
-Default: localhost
+ Default: localhost
 
 =item B<--to-path>
 
@@ -47,7 +51,7 @@ URL path to add as prefix for the redirected URL path.
 
 If set it must end with a '/'.
 
-Default: use the original URL path.
+ Default: use the original URL path.
 
 =back
 
@@ -117,9 +121,6 @@ The Squid Configuration Manual http://www.squid-cache.org/Doc/config/
 
 =cut
 
-use strict;
-use Getopt::Long;
-use Pod::Usage;
 use File::Basename;
 use URI::URL;